/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

[merge] Storage filename escaping

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""WorkingTree object and friends.
 
18
 
 
19
A WorkingTree represents the editable working copy of a branch.
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
 
23
new revision based on the workingtree and its inventory.
 
24
 
 
25
At the moment every WorkingTree has its own branch.  Remote
 
26
WorkingTrees aren't supported.
 
27
 
 
28
To get a WorkingTree, call bzrdir.open_workingtree() or
 
29
WorkingTree.open(dir).
 
30
"""
 
31
 
 
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
33
 
 
34
# TODO: Give the workingtree sole responsibility for the working inventory;
 
35
# remove the variable and references to it from the branch.  This may require
 
36
# updating the commit code so as to update the inventory within the working
 
37
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
38
# At the moment they may alias the inventory and have old copies of it in
 
39
# memory.  (Now done? -- mbp 20060309)
 
40
 
 
41
from copy import deepcopy
 
42
from cStringIO import StringIO
 
43
import errno
 
44
import fnmatch
 
45
import os
 
46
import stat
 
47
 
 
48
 
 
49
from bzrlib.atomicfile import AtomicFile
 
50
from bzrlib.branch import (Branch,
 
51
                           quotefn)
 
52
import bzrlib.bzrdir as bzrdir
 
53
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
54
import bzrlib.errors as errors
 
55
from bzrlib.errors import (BzrCheckError,
 
56
                           BzrError,
 
57
                           DivergedBranches,
 
58
                           WeaveRevisionNotPresent,
 
59
                           NotBranchError,
 
60
                           NoSuchFile,
 
61
                           NotVersionedError,
 
62
                           MergeModifiedFormatError)
 
63
from bzrlib.inventory import InventoryEntry, Inventory
 
64
from bzrlib.lockable_files import LockableFiles, TransportLock
 
65
from bzrlib.lockdir import LockDir
 
66
from bzrlib.merge import merge_inner, transform_tree
 
67
from bzrlib.osutils import (
 
68
                            abspath,
 
69
                            appendpath,
 
70
                            compact_date,
 
71
                            file_kind,
 
72
                            isdir,
 
73
                            getcwd,
 
74
                            pathjoin,
 
75
                            pumpfile,
 
76
                            safe_unicode,
 
77
                            splitpath,
 
78
                            rand_bytes,
 
79
                            normpath,
 
80
                            realpath,
 
81
                            relpath,
 
82
                            rename,
 
83
                            supports_executable,
 
84
                            )
 
85
from bzrlib.progress import DummyProgress
 
86
from bzrlib.revision import NULL_REVISION
 
87
from bzrlib.rio import RioReader, RioWriter, Stanza
 
88
from bzrlib.symbol_versioning import *
 
89
from bzrlib.textui import show_status
 
90
import bzrlib.tree
 
91
from bzrlib.transform import build_tree
 
92
from bzrlib.trace import mutter, note
 
93
from bzrlib.transport import get_transport
 
94
from bzrlib.transport.local import LocalTransport
 
95
import bzrlib.ui
 
96
import bzrlib.xml5
 
97
 
 
98
 
 
99
def gen_file_id(name):
 
100
    """Return new file id.
 
101
 
 
102
    This should probably generate proper UUIDs, but for the moment we
 
103
    cope with just randomness because running uuidgen every time is
 
104
    slow."""
 
105
    import re
 
106
    from binascii import hexlify
 
107
    from time import time
 
108
 
 
109
    # get last component
 
110
    idx = name.rfind('/')
 
111
    if idx != -1:
 
112
        name = name[idx+1 : ]
 
113
    idx = name.rfind('\\')
 
114
    if idx != -1:
 
115
        name = name[idx+1 : ]
 
116
 
 
117
    # make it not a hidden file
 
118
    name = name.lstrip('.')
 
119
 
 
120
    # remove any wierd characters; we don't escape them but rather
 
121
    # just pull them out
 
122
    name = re.sub(r'[^\w.]', '', name)
 
123
 
 
124
    s = hexlify(rand_bytes(8))
 
125
    return '-'.join((name, compact_date(time()), s))
 
126
 
 
127
 
 
128
def gen_root_id():
 
129
    """Return a new tree-root file id."""
 
130
    return gen_file_id('TREE_ROOT')
 
131
 
 
132
 
 
133
class TreeEntry(object):
 
134
    """An entry that implements the minium interface used by commands.
 
135
 
 
136
    This needs further inspection, it may be better to have 
 
137
    InventoryEntries without ids - though that seems wrong. For now,
 
138
    this is a parallel hierarchy to InventoryEntry, and needs to become
 
139
    one of several things: decorates to that hierarchy, children of, or
 
140
    parents of it.
 
141
    Another note is that these objects are currently only used when there is
 
142
    no InventoryEntry available - i.e. for unversioned objects.
 
143
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
 
144
    """
 
145
 
 
146
    def __eq__(self, other):
 
147
        # yes, this us ugly, TODO: best practice __eq__ style.
 
148
        return (isinstance(other, TreeEntry)
 
149
                and other.__class__ == self.__class__)
 
150
 
 
151
    def kind_character(self):
 
152
        return "???"
 
153
 
 
154
 
 
155
class TreeDirectory(TreeEntry):
 
156
    """See TreeEntry. This is a directory in a working tree."""
 
157
 
 
158
    def __eq__(self, other):
 
159
        return (isinstance(other, TreeDirectory)
 
160
                and other.__class__ == self.__class__)
 
161
 
 
162
    def kind_character(self):
 
163
        return "/"
 
164
 
 
165
 
 
166
class TreeFile(TreeEntry):
 
167
    """See TreeEntry. This is a regular file in a working tree."""
 
168
 
 
169
    def __eq__(self, other):
 
170
        return (isinstance(other, TreeFile)
 
171
                and other.__class__ == self.__class__)
 
172
 
 
173
    def kind_character(self):
 
174
        return ''
 
175
 
 
176
 
 
177
class TreeLink(TreeEntry):
 
178
    """See TreeEntry. This is a symlink in a working tree."""
 
179
 
 
180
    def __eq__(self, other):
 
181
        return (isinstance(other, TreeLink)
 
182
                and other.__class__ == self.__class__)
 
183
 
 
184
    def kind_character(self):
 
185
        return ''
 
186
 
 
187
 
 
188
class WorkingTree(bzrlib.tree.Tree):
 
189
    """Working copy tree.
 
190
 
 
191
    The inventory is held in the `Branch` working-inventory, and the
 
192
    files are in a directory on disk.
 
193
 
 
194
    It is possible for a `WorkingTree` to have a filename which is
 
195
    not listed in the Inventory and vice versa.
 
196
    """
 
197
 
 
198
    def __init__(self, basedir='.',
 
199
                 branch=DEPRECATED_PARAMETER,
 
200
                 _inventory=None,
 
201
                 _control_files=None,
 
202
                 _internal=False,
 
203
                 _format=None,
 
204
                 _bzrdir=None):
 
205
        """Construct a WorkingTree for basedir.
 
206
 
 
207
        If the branch is not supplied, it is opened automatically.
 
208
        If the branch is supplied, it must be the branch for this basedir.
 
209
        (branch.base is not cross checked, because for remote branches that
 
210
        would be meaningless).
 
211
        """
 
212
        self._format = _format
 
213
        self.bzrdir = _bzrdir
 
214
        if not _internal:
 
215
            # not created via open etc.
 
216
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
217
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
218
                 DeprecationWarning,
 
219
                 stacklevel=2)
 
220
            wt = WorkingTree.open(basedir)
 
221
            self.branch = wt.branch
 
222
            self.basedir = wt.basedir
 
223
            self._control_files = wt._control_files
 
224
            self._hashcache = wt._hashcache
 
225
            self._set_inventory(wt._inventory)
 
226
            self._format = wt._format
 
227
            self.bzrdir = wt.bzrdir
 
228
        from bzrlib.hashcache import HashCache
 
229
        from bzrlib.trace import note, mutter
 
230
        assert isinstance(basedir, basestring), \
 
231
            "base directory %r is not a string" % basedir
 
232
        basedir = safe_unicode(basedir)
 
233
        mutter("opening working tree %r", basedir)
 
234
        if deprecated_passed(branch):
 
235
            if not _internal:
 
236
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
237
                     " Please use bzrdir.open_workingtree() or WorkingTree.open().",
 
238
                     DeprecationWarning,
 
239
                     stacklevel=2
 
240
                     )
 
241
            self.branch = branch
 
242
        else:
 
243
            self.branch = self.bzrdir.open_branch()
 
244
        assert isinstance(self.branch, Branch), \
 
245
            "branch %r is not a Branch" % self.branch
 
246
        self.basedir = realpath(basedir)
 
247
        # if branch is at our basedir and is a format 6 or less
 
248
        if isinstance(self._format, WorkingTreeFormat2):
 
249
            # share control object
 
250
            self._control_files = self.branch.control_files
 
251
        else:
 
252
            # only ready for format 3
 
253
            assert isinstance(self._format, WorkingTreeFormat3)
 
254
            assert isinstance(_control_files, LockableFiles), \
 
255
                    "_control_files must be a LockableFiles, not %r" \
 
256
                    % _control_files
 
257
            self._control_files = _control_files
 
258
        # update the whole cache up front and write to disk if anything changed;
 
259
        # in the future we might want to do this more selectively
 
260
        # two possible ways offer themselves : in self._unlock, write the cache
 
261
        # if needed, or, when the cache sees a change, append it to the hash
 
262
        # cache file, and have the parser take the most recent entry for a
 
263
        # given path only.
 
264
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
 
265
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
266
        hc.read()
 
267
        # is this scan needed ? it makes things kinda slow.
 
268
        hc.scan()
 
269
 
 
270
        if hc.needs_write:
 
271
            mutter("write hc")
 
272
            hc.write()
 
273
 
 
274
        if _inventory is None:
 
275
            self._set_inventory(self.read_working_inventory())
 
276
        else:
 
277
            self._set_inventory(_inventory)
 
278
 
 
279
    def _set_inventory(self, inv):
 
280
        self._inventory = inv
 
281
        self.path2id = self._inventory.path2id
 
282
 
 
283
    def is_control_filename(self, filename):
 
284
        """True if filename is the name of a control file in this tree.
 
285
        
 
286
        This is true IF and ONLY IF the filename is part of the meta data
 
287
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
288
        on disk will not be a control file for this tree.
 
289
        """
 
290
        try:
 
291
            self.bzrdir.transport.relpath(self.abspath(filename))
 
292
            return True
 
293
        except errors.PathNotChild:
 
294
            return False
 
295
 
 
296
    @staticmethod
 
297
    def open(path=None, _unsupported=False):
 
298
        """Open an existing working tree at path.
 
299
 
 
300
        """
 
301
        if path is None:
 
302
            path = os.path.getcwdu()
 
303
        control = bzrdir.BzrDir.open(path, _unsupported)
 
304
        return control.open_workingtree(_unsupported)
 
305
        
 
306
    @staticmethod
 
307
    def open_containing(path=None):
 
308
        """Open an existing working tree which has its root about path.
 
309
        
 
310
        This probes for a working tree at path and searches upwards from there.
 
311
 
 
312
        Basically we keep looking up until we find the control directory or
 
313
        run into /.  If there isn't one, raises NotBranchError.
 
314
        TODO: give this a new exception.
 
315
        If there is one, it is returned, along with the unused portion of path.
 
316
        """
 
317
        if path is None:
 
318
            path = os.getcwdu()
 
319
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
320
        return control.open_workingtree(), relpath
 
321
 
 
322
    @staticmethod
 
323
    def open_downlevel(path=None):
 
324
        """Open an unsupported working tree.
 
325
 
 
326
        Only intended for advanced situations like upgrading part of a bzrdir.
 
327
        """
 
328
        return WorkingTree.open(path, _unsupported=True)
 
329
 
 
330
    def __iter__(self):
 
331
        """Iterate through file_ids for this tree.
 
332
 
 
333
        file_ids are in a WorkingTree if they are in the working inventory
 
334
        and the working file exists.
 
335
        """
 
336
        inv = self._inventory
 
337
        for path, ie in inv.iter_entries():
 
338
            if bzrlib.osutils.lexists(self.abspath(path)):
 
339
                yield ie.file_id
 
340
 
 
341
    def __repr__(self):
 
342
        return "<%s of %s>" % (self.__class__.__name__,
 
343
                               getattr(self, 'basedir', None))
 
344
 
 
345
    def abspath(self, filename):
 
346
        return pathjoin(self.basedir, filename)
 
347
    
 
348
    def basis_tree(self):
 
349
        """Return RevisionTree for the current last revision."""
 
350
        revision_id = self.last_revision()
 
351
        if revision_id is not None:
 
352
            try:
 
353
                xml = self.read_basis_inventory(revision_id)
 
354
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
355
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
 
356
                                                revision_id)
 
357
            except NoSuchFile:
 
358
                pass
 
359
        return self.branch.repository.revision_tree(revision_id)
 
360
 
 
361
    @staticmethod
 
362
    @deprecated_method(zero_eight)
 
363
    def create(branch, directory):
 
364
        """Create a workingtree for branch at directory.
 
365
 
 
366
        If existing_directory already exists it must have a .bzr directory.
 
367
        If it does not exist, it will be created.
 
368
 
 
369
        This returns a new WorkingTree object for the new checkout.
 
370
 
 
371
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
372
        should accept an optional revisionid to checkout [and reject this if
 
373
        checking out into the same dir as a pre-checkout-aware branch format.]
 
374
 
 
375
        XXX: When BzrDir is present, these should be created through that 
 
376
        interface instead.
 
377
        """
 
378
        warn('delete WorkingTree.create', stacklevel=3)
 
379
        transport = get_transport(directory)
 
380
        if branch.bzrdir.root_transport.base == transport.base:
 
381
            # same dir 
 
382
            return branch.bzrdir.create_workingtree()
 
383
        # different directory, 
 
384
        # create a branch reference
 
385
        # and now a working tree.
 
386
        raise NotImplementedError
 
387
 
 
388
    @staticmethod
 
389
    @deprecated_method(zero_eight)
 
390
    def create_standalone(directory):
 
391
        """Create a checkout and a branch and a repo at directory.
 
392
 
 
393
        Directory must exist and be empty.
 
394
 
 
395
        please use BzrDir.create_standalone_workingtree
 
396
        """
 
397
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
398
 
 
399
    def relpath(self, abs):
 
400
        """Return the local path portion from a given absolute path."""
 
401
        return relpath(self.basedir, abs)
 
402
 
 
403
    def has_filename(self, filename):
 
404
        return bzrlib.osutils.lexists(self.abspath(filename))
 
405
 
 
406
    def get_file(self, file_id):
 
407
        return self.get_file_byname(self.id2path(file_id))
 
408
 
 
409
    def get_file_byname(self, filename):
 
410
        return file(self.abspath(filename), 'rb')
 
411
 
 
412
    def get_root_id(self):
 
413
        """Return the id of this trees root"""
 
414
        inv = self.read_working_inventory()
 
415
        return inv.root.file_id
 
416
        
 
417
    def _get_store_filename(self, file_id):
 
418
        ## XXX: badly named; this is not in the store at all
 
419
        return self.abspath(self.id2path(file_id))
 
420
 
 
421
    @needs_read_lock
 
422
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
423
        """Duplicate this working tree into to_bzr, including all state.
 
424
        
 
425
        Specifically modified files are kept as modified, but
 
426
        ignored and unknown files are discarded.
 
427
 
 
428
        If you want to make a new line of development, see bzrdir.sprout()
 
429
 
 
430
        revision
 
431
            If not None, the cloned tree will have its last revision set to 
 
432
            revision, and and difference between the source trees last revision
 
433
            and this one merged in.
 
434
 
 
435
        basis
 
436
            If not None, a closer copy of a tree which may have some files in
 
437
            common, and which file content should be preferentially copied from.
 
438
        """
 
439
        # assumes the target bzr dir format is compatible.
 
440
        result = self._format.initialize(to_bzrdir)
 
441
        self.copy_content_into(result, revision_id)
 
442
        return result
 
443
 
 
444
    @needs_read_lock
 
445
    def copy_content_into(self, tree, revision_id=None):
 
446
        """Copy the current content and user files of this tree into tree."""
 
447
        if revision_id is None:
 
448
            transform_tree(tree, self)
 
449
        else:
 
450
            # TODO now merge from tree.last_revision to revision
 
451
            transform_tree(tree, self)
 
452
            tree.set_last_revision(revision_id)
 
453
 
 
454
    @needs_write_lock
 
455
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
456
        # avoid circular imports
 
457
        from bzrlib.commit import Commit
 
458
        if revprops is None:
 
459
            revprops = {}
 
460
        if not 'branch-nick' in revprops:
 
461
            revprops['branch-nick'] = self.branch.nick
 
462
        # args for wt.commit start at message from the Commit.commit method,
 
463
        # but with branch a kwarg now, passing in args as is results in the
 
464
        #message being used for the branch
 
465
        args = (DEPRECATED_PARAMETER, message, ) + args
 
466
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
 
467
        self._set_inventory(self.read_working_inventory())
 
468
 
 
469
    def id2abspath(self, file_id):
 
470
        return self.abspath(self.id2path(file_id))
 
471
 
 
472
    def has_id(self, file_id):
 
473
        # files that have been deleted are excluded
 
474
        inv = self._inventory
 
475
        if not inv.has_id(file_id):
 
476
            return False
 
477
        path = inv.id2path(file_id)
 
478
        return bzrlib.osutils.lexists(self.abspath(path))
 
479
 
 
480
    def has_or_had_id(self, file_id):
 
481
        if file_id == self.inventory.root.file_id:
 
482
            return True
 
483
        return self.inventory.has_id(file_id)
 
484
 
 
485
    __contains__ = has_id
 
486
 
 
487
    def get_file_size(self, file_id):
 
488
        return os.path.getsize(self.id2abspath(file_id))
 
489
 
 
490
    @needs_read_lock
 
491
    def get_file_sha1(self, file_id):
 
492
        path = self._inventory.id2path(file_id)
 
493
        return self._hashcache.get_sha1(path)
 
494
 
 
495
    def is_executable(self, file_id):
 
496
        if not supports_executable():
 
497
            return self._inventory[file_id].executable
 
498
        else:
 
499
            path = self._inventory.id2path(file_id)
 
500
            mode = os.lstat(self.abspath(path)).st_mode
 
501
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
502
 
 
503
    @needs_write_lock
 
504
    def add(self, files, ids=None):
 
505
        """Make files versioned.
 
506
 
 
507
        Note that the command line normally calls smart_add instead,
 
508
        which can automatically recurse.
 
509
 
 
510
        This adds the files to the inventory, so that they will be
 
511
        recorded by the next commit.
 
512
 
 
513
        files
 
514
            List of paths to add, relative to the base of the tree.
 
515
 
 
516
        ids
 
517
            If set, use these instead of automatically generated ids.
 
518
            Must be the same length as the list of files, but may
 
519
            contain None for ids that are to be autogenerated.
 
520
 
 
521
        TODO: Perhaps have an option to add the ids even if the files do
 
522
              not (yet) exist.
 
523
 
 
524
        TODO: Perhaps callback with the ids and paths as they're added.
 
525
        """
 
526
        # TODO: Re-adding a file that is removed in the working copy
 
527
        # should probably put it back with the previous ID.
 
528
        if isinstance(files, basestring):
 
529
            assert(ids is None or isinstance(ids, basestring))
 
530
            files = [files]
 
531
            if ids is not None:
 
532
                ids = [ids]
 
533
 
 
534
        if ids is None:
 
535
            ids = [None] * len(files)
 
536
        else:
 
537
            assert(len(ids) == len(files))
 
538
 
 
539
        inv = self.read_working_inventory()
 
540
        for f,file_id in zip(files, ids):
 
541
            if self.is_control_filename(f):
 
542
                raise BzrError("cannot add control file %s" % quotefn(f))
 
543
 
 
544
            fp = splitpath(f)
 
545
 
 
546
            if len(fp) == 0:
 
547
                raise BzrError("cannot add top-level %r" % f)
 
548
 
 
549
            fullpath = normpath(self.abspath(f))
 
550
 
 
551
            try:
 
552
                kind = file_kind(fullpath)
 
553
            except OSError, e:
 
554
                if e.errno == errno.ENOENT:
 
555
                    raise NoSuchFile(fullpath)
 
556
                # maybe something better?
 
557
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
558
 
 
559
            if not InventoryEntry.versionable_kind(kind):
 
560
                raise BzrError('cannot add: not a versionable file ('
 
561
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
562
 
 
563
            if file_id is None:
 
564
                file_id = gen_file_id(f)
 
565
            inv.add_path(f, kind=kind, file_id=file_id)
 
566
 
 
567
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
568
        self._write_inventory(inv)
 
569
 
 
570
    @needs_write_lock
 
571
    def add_pending_merge(self, *revision_ids):
 
572
        # TODO: Perhaps should check at this point that the
 
573
        # history of the revision is actually present?
 
574
        p = self.pending_merges()
 
575
        updated = False
 
576
        for rev_id in revision_ids:
 
577
            if rev_id in p:
 
578
                continue
 
579
            p.append(rev_id)
 
580
            updated = True
 
581
        if updated:
 
582
            self.set_pending_merges(p)
 
583
 
 
584
    @needs_read_lock
 
585
    def pending_merges(self):
 
586
        """Return a list of pending merges.
 
587
 
 
588
        These are revisions that have been merged into the working
 
589
        directory but not yet committed.
 
590
        """
 
591
        try:
 
592
            merges_file = self._control_files.get_utf8('pending-merges')
 
593
        except OSError, e:
 
594
            if e.errno != errno.ENOENT:
 
595
                raise
 
596
            return []
 
597
        p = []
 
598
        for l in merges_file.readlines():
 
599
            p.append(l.rstrip('\n'))
 
600
        return p
 
601
 
 
602
    @needs_write_lock
 
603
    def set_pending_merges(self, rev_list):
 
604
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
605
 
 
606
    @needs_write_lock
 
607
    def set_merge_modified(self, modified_hashes):
 
608
        my_file = StringIO()
 
609
        my_file.write(MERGE_MODIFIED_HEADER_1 + '\n')
 
610
        writer = RioWriter(my_file)
 
611
        for file_id, hash in modified_hashes.iteritems():
 
612
            s = Stanza(file_id=file_id, hash=hash)
 
613
            writer.write_stanza(s)
 
614
        my_file.seek(0)
 
615
        self._control_files.put('merge-hashes', my_file)
 
616
 
 
617
    @needs_read_lock
 
618
    def merge_modified(self):
 
619
        try:
 
620
            hashfile = self._control_files.get('merge-hashes')
 
621
        except NoSuchFile:
 
622
            return {}
 
623
        merge_hashes = {}
 
624
        try:
 
625
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
626
                raise MergeModifiedFormatError()
 
627
        except StopIteration:
 
628
            raise MergeModifiedFormatError()
 
629
        for s in RioReader(hashfile):
 
630
            file_id = s.get("file_id")
 
631
            hash = s.get("hash")
 
632
            if hash == self.get_file_sha1(file_id):
 
633
                merge_hashes[file_id] = hash
 
634
        return merge_hashes
 
635
 
 
636
    def get_symlink_target(self, file_id):
 
637
        return os.readlink(self.id2abspath(file_id))
 
638
 
 
639
    def file_class(self, filename):
 
640
        if self.path2id(filename):
 
641
            return 'V'
 
642
        elif self.is_ignored(filename):
 
643
            return 'I'
 
644
        else:
 
645
            return '?'
 
646
 
 
647
    def list_files(self):
 
648
        """Recursively list all files as (path, class, kind, id).
 
649
 
 
650
        Lists, but does not descend into unversioned directories.
 
651
 
 
652
        This does not include files that have been deleted in this
 
653
        tree.
 
654
 
 
655
        Skips the control directory.
 
656
        """
 
657
        inv = self._inventory
 
658
 
 
659
        def descend(from_dir_relpath, from_dir_id, dp):
 
660
            ls = os.listdir(dp)
 
661
            ls.sort()
 
662
            for f in ls:
 
663
                ## TODO: If we find a subdirectory with its own .bzr
 
664
                ## directory, then that is a separate tree and we
 
665
                ## should exclude it.
 
666
 
 
667
                # the bzrdir for this tree
 
668
                if self.bzrdir.transport.base.endswith(f + '/'):
 
669
                    continue
 
670
 
 
671
                # path within tree
 
672
                fp = appendpath(from_dir_relpath, f)
 
673
 
 
674
                # absolute path
 
675
                fap = appendpath(dp, f)
 
676
                
 
677
                f_ie = inv.get_child(from_dir_id, f)
 
678
                if f_ie:
 
679
                    c = 'V'
 
680
                elif self.is_ignored(fp):
 
681
                    c = 'I'
 
682
                else:
 
683
                    c = '?'
 
684
 
 
685
                fk = file_kind(fap)
 
686
 
 
687
                if f_ie:
 
688
                    if f_ie.kind != fk:
 
689
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
690
                                            "now of kind %r"
 
691
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
692
 
 
693
                # make a last minute entry
 
694
                if f_ie:
 
695
                    entry = f_ie
 
696
                else:
 
697
                    if fk == 'directory':
 
698
                        entry = TreeDirectory()
 
699
                    elif fk == 'file':
 
700
                        entry = TreeFile()
 
701
                    elif fk == 'symlink':
 
702
                        entry = TreeLink()
 
703
                    else:
 
704
                        entry = TreeEntry()
 
705
                
 
706
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
 
707
 
 
708
                if fk != 'directory':
 
709
                    continue
 
710
 
 
711
                if c != 'V':
 
712
                    # don't descend unversioned directories
 
713
                    continue
 
714
                
 
715
                for ff in descend(fp, f_ie.file_id, fap):
 
716
                    yield ff
 
717
 
 
718
        for f in descend(u'', inv.root.file_id, self.basedir):
 
719
            yield f
 
720
 
 
721
    @needs_write_lock
 
722
    def move(self, from_paths, to_name):
 
723
        """Rename files.
 
724
 
 
725
        to_name must exist in the inventory.
 
726
 
 
727
        If to_name exists and is a directory, the files are moved into
 
728
        it, keeping their old names.  
 
729
 
 
730
        Note that to_name is only the last component of the new name;
 
731
        this doesn't change the directory.
 
732
 
 
733
        This returns a list of (from_path, to_path) pairs for each
 
734
        entry that is moved.
 
735
        """
 
736
        result = []
 
737
        ## TODO: Option to move IDs only
 
738
        assert not isinstance(from_paths, basestring)
 
739
        inv = self.inventory
 
740
        to_abs = self.abspath(to_name)
 
741
        if not isdir(to_abs):
 
742
            raise BzrError("destination %r is not a directory" % to_abs)
 
743
        if not self.has_filename(to_name):
 
744
            raise BzrError("destination %r not in working directory" % to_abs)
 
745
        to_dir_id = inv.path2id(to_name)
 
746
        if to_dir_id == None and to_name != '':
 
747
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
748
        to_dir_ie = inv[to_dir_id]
 
749
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
750
            raise BzrError("destination %r is not a directory" % to_abs)
 
751
 
 
752
        to_idpath = inv.get_idpath(to_dir_id)
 
753
 
 
754
        for f in from_paths:
 
755
            if not self.has_filename(f):
 
756
                raise BzrError("%r does not exist in working tree" % f)
 
757
            f_id = inv.path2id(f)
 
758
            if f_id == None:
 
759
                raise BzrError("%r is not versioned" % f)
 
760
            name_tail = splitpath(f)[-1]
 
761
            dest_path = appendpath(to_name, name_tail)
 
762
            if self.has_filename(dest_path):
 
763
                raise BzrError("destination %r already exists" % dest_path)
 
764
            if f_id in to_idpath:
 
765
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
766
 
 
767
        # OK, so there's a race here, it's possible that someone will
 
768
        # create a file in this interval and then the rename might be
 
769
        # left half-done.  But we should have caught most problems.
 
770
        orig_inv = deepcopy(self.inventory)
 
771
        try:
 
772
            for f in from_paths:
 
773
                name_tail = splitpath(f)[-1]
 
774
                dest_path = appendpath(to_name, name_tail)
 
775
                result.append((f, dest_path))
 
776
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
777
                try:
 
778
                    rename(self.abspath(f), self.abspath(dest_path))
 
779
                except OSError, e:
 
780
                    raise BzrError("failed to rename %r to %r: %s" %
 
781
                                   (f, dest_path, e[1]),
 
782
                            ["rename rolled back"])
 
783
        except:
 
784
            # restore the inventory on error
 
785
            self._set_inventory(orig_inv)
 
786
            raise
 
787
        self._write_inventory(inv)
 
788
        return result
 
789
 
 
790
    @needs_write_lock
 
791
    def rename_one(self, from_rel, to_rel):
 
792
        """Rename one file.
 
793
 
 
794
        This can change the directory or the filename or both.
 
795
        """
 
796
        inv = self.inventory
 
797
        if not self.has_filename(from_rel):
 
798
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
799
        if self.has_filename(to_rel):
 
800
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
801
 
 
802
        file_id = inv.path2id(from_rel)
 
803
        if file_id == None:
 
804
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
805
 
 
806
        entry = inv[file_id]
 
807
        from_parent = entry.parent_id
 
808
        from_name = entry.name
 
809
        
 
810
        if inv.path2id(to_rel):
 
811
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
812
 
 
813
        to_dir, to_tail = os.path.split(to_rel)
 
814
        to_dir_id = inv.path2id(to_dir)
 
815
        if to_dir_id == None and to_dir != '':
 
816
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
817
 
 
818
        mutter("rename_one:")
 
819
        mutter("  file_id    {%s}" % file_id)
 
820
        mutter("  from_rel   %r" % from_rel)
 
821
        mutter("  to_rel     %r" % to_rel)
 
822
        mutter("  to_dir     %r" % to_dir)
 
823
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
824
 
 
825
        inv.rename(file_id, to_dir_id, to_tail)
 
826
 
 
827
        from_abs = self.abspath(from_rel)
 
828
        to_abs = self.abspath(to_rel)
 
829
        try:
 
830
            rename(from_abs, to_abs)
 
831
        except OSError, e:
 
832
            inv.rename(file_id, from_parent, from_name)
 
833
            raise BzrError("failed to rename %r to %r: %s"
 
834
                    % (from_abs, to_abs, e[1]),
 
835
                    ["rename rolled back"])
 
836
        self._write_inventory(inv)
 
837
 
 
838
    @needs_read_lock
 
839
    def unknowns(self):
 
840
        """Return all unknown files.
 
841
 
 
842
        These are files in the working directory that are not versioned or
 
843
        control files or ignored.
 
844
        
 
845
        >>> from bzrlib.bzrdir import ScratchDir
 
846
        >>> d = ScratchDir(files=['foo', 'foo~'])
 
847
        >>> b = d.open_branch()
 
848
        >>> tree = d.open_workingtree()
 
849
        >>> map(str, tree.unknowns())
 
850
        ['foo']
 
851
        >>> tree.add('foo')
 
852
        >>> list(b.unknowns())
 
853
        []
 
854
        >>> tree.remove('foo')
 
855
        >>> list(b.unknowns())
 
856
        [u'foo']
 
857
        """
 
858
        for subp in self.extras():
 
859
            if not self.is_ignored(subp):
 
860
                yield subp
 
861
 
 
862
    def iter_conflicts(self):
 
863
        conflicted = set()
 
864
        for path in (s[0] for s in self.list_files()):
 
865
            stem = get_conflicted_stem(path)
 
866
            if stem is None:
 
867
                continue
 
868
            if stem not in conflicted:
 
869
                conflicted.add(stem)
 
870
                yield stem
 
871
 
 
872
    @needs_write_lock
 
873
    def pull(self, source, overwrite=False, stop_revision=None):
 
874
        source.lock_read()
 
875
        try:
 
876
            old_revision_history = self.branch.revision_history()
 
877
            basis_tree = self.basis_tree()
 
878
            count = self.branch.pull(source, overwrite, stop_revision)
 
879
            new_revision_history = self.branch.revision_history()
 
880
            if new_revision_history != old_revision_history:
 
881
                if len(old_revision_history):
 
882
                    other_revision = old_revision_history[-1]
 
883
                else:
 
884
                    other_revision = None
 
885
                repository = self.branch.repository
 
886
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
887
                try:
 
888
                    merge_inner(self.branch,
 
889
                                self.branch.basis_tree(),
 
890
                                basis_tree, 
 
891
                                this_tree=self, 
 
892
                                pb=pb)
 
893
                finally:
 
894
                    pb.finished()
 
895
                self.set_last_revision(self.branch.last_revision())
 
896
            return count
 
897
        finally:
 
898
            source.unlock()
 
899
 
 
900
    def extras(self):
 
901
        """Yield all unknown files in this WorkingTree.
 
902
 
 
903
        If there are any unknown directories then only the directory is
 
904
        returned, not all its children.  But if there are unknown files
 
905
        under a versioned subdirectory, they are returned.
 
906
 
 
907
        Currently returned depth-first, sorted by name within directories.
 
908
        """
 
909
        ## TODO: Work from given directory downwards
 
910
        for path, dir_entry in self.inventory.directories():
 
911
            mutter("search for unknowns in %r", path)
 
912
            dirabs = self.abspath(path)
 
913
            if not isdir(dirabs):
 
914
                # e.g. directory deleted
 
915
                continue
 
916
 
 
917
            fl = []
 
918
            for subf in os.listdir(dirabs):
 
919
                if (subf != '.bzr'
 
920
                    and (subf not in dir_entry.children)):
 
921
                    fl.append(subf)
 
922
            
 
923
            fl.sort()
 
924
            for subf in fl:
 
925
                subp = appendpath(path, subf)
 
926
                yield subp
 
927
 
 
928
 
 
929
    def ignored_files(self):
 
930
        """Yield list of PATH, IGNORE_PATTERN"""
 
931
        for subp in self.extras():
 
932
            pat = self.is_ignored(subp)
 
933
            if pat != None:
 
934
                yield subp, pat
 
935
 
 
936
 
 
937
    def get_ignore_list(self):
 
938
        """Return list of ignore patterns.
 
939
 
 
940
        Cached in the Tree object after the first call.
 
941
        """
 
942
        if hasattr(self, '_ignorelist'):
 
943
            return self._ignorelist
 
944
 
 
945
        l = bzrlib.DEFAULT_IGNORE[:]
 
946
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
947
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
948
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
949
        self._ignorelist = l
 
950
        return l
 
951
 
 
952
 
 
953
    def is_ignored(self, filename):
 
954
        r"""Check whether the filename matches an ignore pattern.
 
955
 
 
956
        Patterns containing '/' or '\' need to match the whole path;
 
957
        others match against only the last component.
 
958
 
 
959
        If the file is ignored, returns the pattern which caused it to
 
960
        be ignored, otherwise None.  So this can simply be used as a
 
961
        boolean if desired."""
 
962
 
 
963
        # TODO: Use '**' to match directories, and other extended
 
964
        # globbing stuff from cvs/rsync.
 
965
 
 
966
        # XXX: fnmatch is actually not quite what we want: it's only
 
967
        # approximately the same as real Unix fnmatch, and doesn't
 
968
        # treat dotfiles correctly and allows * to match /.
 
969
        # Eventually it should be replaced with something more
 
970
        # accurate.
 
971
        
 
972
        for pat in self.get_ignore_list():
 
973
            if '/' in pat or '\\' in pat:
 
974
                
 
975
                # as a special case, you can put ./ at the start of a
 
976
                # pattern; this is good to match in the top-level
 
977
                # only;
 
978
                
 
979
                if (pat[:2] == './') or (pat[:2] == '.\\'):
 
980
                    newpat = pat[2:]
 
981
                else:
 
982
                    newpat = pat
 
983
                if fnmatch.fnmatchcase(filename, newpat):
 
984
                    return pat
 
985
            else:
 
986
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
987
                    return pat
 
988
        else:
 
989
            return None
 
990
 
 
991
    def kind(self, file_id):
 
992
        return file_kind(self.id2abspath(file_id))
 
993
 
 
994
    @needs_read_lock
 
995
    def last_revision(self):
 
996
        """Return the last revision id of this working tree.
 
997
 
 
998
        In early branch formats this was == the branch last_revision,
 
999
        but that cannot be relied upon - for working tree operations,
 
1000
        always use tree.last_revision().
 
1001
        """
 
1002
        return self.branch.last_revision()
 
1003
 
 
1004
    def lock_read(self):
 
1005
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1006
        self.branch.lock_read()
 
1007
        try:
 
1008
            return self._control_files.lock_read()
 
1009
        except:
 
1010
            self.branch.unlock()
 
1011
            raise
 
1012
 
 
1013
    def lock_write(self):
 
1014
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1015
        self.branch.lock_write()
 
1016
        try:
 
1017
            return self._control_files.lock_write()
 
1018
        except:
 
1019
            self.branch.unlock()
 
1020
            raise
 
1021
 
 
1022
    def _basis_inventory_name(self, revision_id):
 
1023
        return 'basis-inventory.%s' % revision_id
 
1024
 
 
1025
    @needs_write_lock
 
1026
    def set_last_revision(self, new_revision, old_revision=None):
 
1027
        """Change the last revision in the working tree."""
 
1028
        self._remove_old_basis(old_revision)
 
1029
        if self._change_last_revision(new_revision):
 
1030
            self._cache_basis_inventory(new_revision)
 
1031
 
 
1032
    def _change_last_revision(self, new_revision):
 
1033
        """Template method part of set_last_revision to perform the change."""
 
1034
        if new_revision is None:
 
1035
            self.branch.set_revision_history([])
 
1036
            return False
 
1037
        # current format is locked in with the branch
 
1038
        revision_history = self.branch.revision_history()
 
1039
        try:
 
1040
            position = revision_history.index(new_revision)
 
1041
        except ValueError:
 
1042
            raise errors.NoSuchRevision(self.branch, new_revision)
 
1043
        self.branch.set_revision_history(revision_history[:position + 1])
 
1044
        return True
 
1045
 
 
1046
    def _cache_basis_inventory(self, new_revision):
 
1047
        """Cache new_revision as the basis inventory."""
 
1048
        try:
 
1049
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1050
            path = self._basis_inventory_name(new_revision)
 
1051
            self._control_files.put_utf8(path, xml)
 
1052
        except WeaveRevisionNotPresent:
 
1053
            pass
 
1054
 
 
1055
    def _remove_old_basis(self, old_revision):
 
1056
        """Remove the old basis inventory 'old_revision'."""
 
1057
        if old_revision is not None:
 
1058
            try:
 
1059
                path = self._basis_inventory_name(old_revision)
 
1060
                path = self._control_files._escape(path)
 
1061
                self._control_files._transport.delete(path)
 
1062
            except NoSuchFile:
 
1063
                pass
 
1064
 
 
1065
    def read_basis_inventory(self, revision_id):
 
1066
        """Read the cached basis inventory."""
 
1067
        path = self._basis_inventory_name(revision_id)
 
1068
        return self._control_files.get_utf8(path).read()
 
1069
        
 
1070
    @needs_read_lock
 
1071
    def read_working_inventory(self):
 
1072
        """Read the working inventory."""
 
1073
        # ElementTree does its own conversion from UTF-8, so open in
 
1074
        # binary.
 
1075
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1076
            self._control_files.get('inventory'))
 
1077
        self._set_inventory(result)
 
1078
        return result
 
1079
 
 
1080
    @needs_write_lock
 
1081
    def remove(self, files, verbose=False):
 
1082
        """Remove nominated files from the working inventory..
 
1083
 
 
1084
        This does not remove their text.  This does not run on XXX on what? RBC
 
1085
 
 
1086
        TODO: Refuse to remove modified files unless --force is given?
 
1087
 
 
1088
        TODO: Do something useful with directories.
 
1089
 
 
1090
        TODO: Should this remove the text or not?  Tough call; not
 
1091
        removing may be useful and the user can just use use rm, and
 
1092
        is the opposite of add.  Removing it is consistent with most
 
1093
        other tools.  Maybe an option.
 
1094
        """
 
1095
        ## TODO: Normalize names
 
1096
        ## TODO: Remove nested loops; better scalability
 
1097
        if isinstance(files, basestring):
 
1098
            files = [files]
 
1099
 
 
1100
        inv = self.inventory
 
1101
 
 
1102
        # do this before any modifications
 
1103
        for f in files:
 
1104
            fid = inv.path2id(f)
 
1105
            if not fid:
 
1106
                # TODO: Perhaps make this just a warning, and continue?
 
1107
                # This tends to happen when 
 
1108
                raise NotVersionedError(path=f)
 
1109
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
 
1110
            if verbose:
 
1111
                # having remove it, it must be either ignored or unknown
 
1112
                if self.is_ignored(f):
 
1113
                    new_status = 'I'
 
1114
                else:
 
1115
                    new_status = '?'
 
1116
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1117
            del inv[fid]
 
1118
 
 
1119
        self._write_inventory(inv)
 
1120
 
 
1121
    @needs_write_lock
 
1122
    def revert(self, filenames, old_tree=None, backups=True, 
 
1123
               pb=DummyProgress()):
 
1124
        from transform import revert
 
1125
        if old_tree is None:
 
1126
            old_tree = self.basis_tree()
 
1127
        revert(self, old_tree, filenames, backups, pb)
 
1128
        if not len(filenames):
 
1129
            self.set_pending_merges([])
 
1130
 
 
1131
    @needs_write_lock
 
1132
    def set_inventory(self, new_inventory_list):
 
1133
        from bzrlib.inventory import (Inventory,
 
1134
                                      InventoryDirectory,
 
1135
                                      InventoryEntry,
 
1136
                                      InventoryFile,
 
1137
                                      InventoryLink)
 
1138
        inv = Inventory(self.get_root_id())
 
1139
        for path, file_id, parent, kind, executable in new_inventory_list:
 
1140
            name = os.path.basename(path)
 
1141
            if name == "":
 
1142
                continue
 
1143
            # fixme, there should be a factory function inv,add_?? 
 
1144
            if kind == 'directory':
 
1145
                inv.add(InventoryDirectory(file_id, name, parent))
 
1146
            elif kind == 'file':
 
1147
                ie = InventoryFile(file_id, name, parent)
 
1148
                ie.executable = executable
 
1149
                inv.add(ie)
 
1150
            elif kind == 'symlink':
 
1151
                inv.add(InventoryLink(file_id, name, parent))
 
1152
            else:
 
1153
                raise BzrError("unknown kind %r" % kind)
 
1154
        self._write_inventory(inv)
 
1155
 
 
1156
    @needs_write_lock
 
1157
    def set_root_id(self, file_id):
 
1158
        """Set the root id for this tree."""
 
1159
        inv = self.read_working_inventory()
 
1160
        orig_root_id = inv.root.file_id
 
1161
        del inv._byid[inv.root.file_id]
 
1162
        inv.root.file_id = file_id
 
1163
        inv._byid[inv.root.file_id] = inv.root
 
1164
        for fid in inv:
 
1165
            entry = inv[fid]
 
1166
            if entry.parent_id == orig_root_id:
 
1167
                entry.parent_id = inv.root.file_id
 
1168
        self._write_inventory(inv)
 
1169
 
 
1170
    def unlock(self):
 
1171
        """See Branch.unlock.
 
1172
        
 
1173
        WorkingTree locking just uses the Branch locking facilities.
 
1174
        This is current because all working trees have an embedded branch
 
1175
        within them. IF in the future, we were to make branch data shareable
 
1176
        between multiple working trees, i.e. via shared storage, then we 
 
1177
        would probably want to lock both the local tree, and the branch.
 
1178
        """
 
1179
        # FIXME: We want to write out the hashcache only when the last lock on
 
1180
        # this working copy is released.  Peeking at the lock count is a bit
 
1181
        # of a nasty hack; probably it's better to have a transaction object,
 
1182
        # which can do some finalization when it's either successfully or
 
1183
        # unsuccessfully completed.  (Denys's original patch did that.)
 
1184
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
 
1185
        # wrongly. Hookinh into unllock on the control files object is fine though.
 
1186
        
 
1187
        # TODO: split this per format so there is no ugly if block
 
1188
        if self._hashcache.needs_write and (
 
1189
            # dedicated lock files
 
1190
            self._control_files._lock_count==1 or 
 
1191
            # shared lock files
 
1192
            (self._control_files is self.branch.control_files and 
 
1193
             self._control_files._lock_count==3)):
 
1194
            self._hashcache.write()
 
1195
        # reverse order of locking.
 
1196
        result = self._control_files.unlock()
 
1197
        try:
 
1198
            self.branch.unlock()
 
1199
        finally:
 
1200
            return result
 
1201
 
 
1202
    @needs_write_lock
 
1203
    def update(self):
 
1204
        """Update a working tree along its branch.
 
1205
 
 
1206
        This will update the branch if its bound too, which means we have multiple trees involved:
 
1207
        The new basis tree of the master.
 
1208
        The old basis tree of the branch.
 
1209
        The old basis tree of the working tree.
 
1210
        The current working tree state.
 
1211
        pathologically all three may be different, and non ancestors of each other.
 
1212
        Conceptually we want to:
 
1213
        Preserve the wt.basis->wt.state changes
 
1214
        Transform the wt.basis to the new master basis.
 
1215
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
 
1216
        Restore the wt.basis->wt.state changes.
 
1217
 
 
1218
        There isn't a single operation at the moment to do that, so we:
 
1219
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
 
1220
        Do a 'normal' merge of the old branch basis if it is relevant.
 
1221
        """
 
1222
        old_tip = self.branch.update()
 
1223
        if old_tip is not None:
 
1224
            self.add_pending_merge(old_tip)
 
1225
        self.branch.lock_read()
 
1226
        try:
 
1227
            result = 0
 
1228
            if self.last_revision() != self.branch.last_revision():
 
1229
                # merge tree state up to new branch tip.
 
1230
                basis = self.basis_tree()
 
1231
                to_tree = self.branch.basis_tree()
 
1232
                result += merge_inner(self.branch,
 
1233
                                      to_tree,
 
1234
                                      basis,
 
1235
                                      this_tree=self)
 
1236
                self.set_last_revision(self.branch.last_revision())
 
1237
            if old_tip and old_tip != self.last_revision():
 
1238
                # our last revision was not the prior branch last reivison
 
1239
                # and we have converted that last revision to a pending merge.
 
1240
                # base is somewhere between the branch tip now
 
1241
                # and the now pending merge
 
1242
                from bzrlib.revision import common_ancestor
 
1243
                try:
 
1244
                    base_rev_id = common_ancestor(self.branch.last_revision(),
 
1245
                                                  old_tip,
 
1246
                                                  self.branch.repository)
 
1247
                except errors.NoCommonAncestor:
 
1248
                    base_rev_id = None
 
1249
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1250
                other_tree = self.branch.repository.revision_tree(old_tip)
 
1251
                result += merge_inner(self.branch,
 
1252
                                      other_tree,
 
1253
                                      base_tree,
 
1254
                                      this_tree=self)
 
1255
            return result
 
1256
        finally:
 
1257
            self.branch.unlock()
 
1258
 
 
1259
    @needs_write_lock
 
1260
    def _write_inventory(self, inv):
 
1261
        """Write inventory as the current inventory."""
 
1262
        sio = StringIO()
 
1263
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1264
        sio.seek(0)
 
1265
        self._control_files.put('inventory', sio)
 
1266
        self._set_inventory(inv)
 
1267
        mutter('wrote working inventory')
 
1268
 
 
1269
 
 
1270
class WorkingTree3(WorkingTree):
 
1271
    """This is the Format 3 working tree.
 
1272
 
 
1273
    This differs from the base WorkingTree by:
 
1274
     - having its own file lock
 
1275
     - having its own last-revision property.
 
1276
 
 
1277
    This is new in bzr 0.8
 
1278
    """
 
1279
 
 
1280
    @needs_read_lock
 
1281
    def last_revision(self):
 
1282
        """See WorkingTree.last_revision."""
 
1283
        try:
 
1284
            return self._control_files.get_utf8('last-revision').read()
 
1285
        except NoSuchFile:
 
1286
            return None
 
1287
 
 
1288
    def _change_last_revision(self, revision_id):
 
1289
        """See WorkingTree._change_last_revision."""
 
1290
        if revision_id is None or revision_id == NULL_REVISION:
 
1291
            try:
 
1292
                self._control_files._transport.delete('last-revision')
 
1293
            except errors.NoSuchFile:
 
1294
                pass
 
1295
            return False
 
1296
        else:
 
1297
            try:
 
1298
                self.branch.revision_history().index(revision_id)
 
1299
            except ValueError:
 
1300
                raise errors.NoSuchRevision(self.branch, revision_id)
 
1301
            self._control_files.put_utf8('last-revision', revision_id)
 
1302
            return True
 
1303
 
 
1304
 
 
1305
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
 
1306
def get_conflicted_stem(path):
 
1307
    for suffix in CONFLICT_SUFFIXES:
 
1308
        if path.endswith(suffix):
 
1309
            return path[:-len(suffix)]
 
1310
 
 
1311
@deprecated_function(zero_eight)
 
1312
def is_control_file(filename):
 
1313
    """See WorkingTree.is_control_filename(filename)."""
 
1314
    ## FIXME: better check
 
1315
    filename = normpath(filename)
 
1316
    while filename != '':
 
1317
        head, tail = os.path.split(filename)
 
1318
        ## mutter('check %r for control file' % ((head, tail),))
 
1319
        if tail == '.bzr':
 
1320
            return True
 
1321
        if filename == head:
 
1322
            break
 
1323
        filename = head
 
1324
    return False
 
1325
 
 
1326
 
 
1327
class WorkingTreeFormat(object):
 
1328
    """An encapsulation of the initialization and open routines for a format.
 
1329
 
 
1330
    Formats provide three things:
 
1331
     * An initialization routine,
 
1332
     * a format string,
 
1333
     * an open routine.
 
1334
 
 
1335
    Formats are placed in an dict by their format string for reference 
 
1336
    during workingtree opening. Its not required that these be instances, they
 
1337
    can be classes themselves with class methods - it simply depends on 
 
1338
    whether state is needed for a given format or not.
 
1339
 
 
1340
    Once a format is deprecated, just deprecate the initialize and open
 
1341
    methods on the format class. Do not deprecate the object, as the 
 
1342
    object will be created every time regardless.
 
1343
    """
 
1344
 
 
1345
    _default_format = None
 
1346
    """The default format used for new trees."""
 
1347
 
 
1348
    _formats = {}
 
1349
    """The known formats."""
 
1350
 
 
1351
    @classmethod
 
1352
    def find_format(klass, a_bzrdir):
 
1353
        """Return the format for the working tree object in a_bzrdir."""
 
1354
        try:
 
1355
            transport = a_bzrdir.get_workingtree_transport(None)
 
1356
            format_string = transport.get("format").read()
 
1357
            return klass._formats[format_string]
 
1358
        except NoSuchFile:
 
1359
            raise errors.NoWorkingTree(base=transport.base)
 
1360
        except KeyError:
 
1361
            raise errors.UnknownFormatError(format_string)
 
1362
 
 
1363
    @classmethod
 
1364
    def get_default_format(klass):
 
1365
        """Return the current default format."""
 
1366
        return klass._default_format
 
1367
 
 
1368
    def get_format_string(self):
 
1369
        """Return the ASCII format string that identifies this format."""
 
1370
        raise NotImplementedError(self.get_format_string)
 
1371
 
 
1372
    def is_supported(self):
 
1373
        """Is this format supported?
 
1374
 
 
1375
        Supported formats can be initialized and opened.
 
1376
        Unsupported formats may not support initialization or committing or 
 
1377
        some other features depending on the reason for not being supported.
 
1378
        """
 
1379
        return True
 
1380
 
 
1381
    @classmethod
 
1382
    def register_format(klass, format):
 
1383
        klass._formats[format.get_format_string()] = format
 
1384
 
 
1385
    @classmethod
 
1386
    def set_default_format(klass, format):
 
1387
        klass._default_format = format
 
1388
 
 
1389
    @classmethod
 
1390
    def unregister_format(klass, format):
 
1391
        assert klass._formats[format.get_format_string()] is format
 
1392
        del klass._formats[format.get_format_string()]
 
1393
 
 
1394
 
 
1395
 
 
1396
class WorkingTreeFormat2(WorkingTreeFormat):
 
1397
    """The second working tree format. 
 
1398
 
 
1399
    This format modified the hash cache from the format 1 hash cache.
 
1400
    """
 
1401
 
 
1402
    def initialize(self, a_bzrdir, revision_id=None):
 
1403
        """See WorkingTreeFormat.initialize()."""
 
1404
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1405
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1406
        branch = a_bzrdir.open_branch()
 
1407
        if revision_id is not None:
 
1408
            branch.lock_write()
 
1409
            try:
 
1410
                revision_history = branch.revision_history()
 
1411
                try:
 
1412
                    position = revision_history.index(revision_id)
 
1413
                except ValueError:
 
1414
                    raise errors.NoSuchRevision(branch, revision_id)
 
1415
                branch.set_revision_history(revision_history[:position + 1])
 
1416
            finally:
 
1417
                branch.unlock()
 
1418
        revision = branch.last_revision()
 
1419
        inv = Inventory() 
 
1420
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
1421
                         branch,
 
1422
                         inv,
 
1423
                         _internal=True,
 
1424
                         _format=self,
 
1425
                         _bzrdir=a_bzrdir)
 
1426
        wt._write_inventory(inv)
 
1427
        wt.set_root_id(inv.root.file_id)
 
1428
        wt.set_last_revision(revision)
 
1429
        wt.set_pending_merges([])
 
1430
        build_tree(wt.basis_tree(), wt)
 
1431
        return wt
 
1432
 
 
1433
    def __init__(self):
 
1434
        super(WorkingTreeFormat2, self).__init__()
 
1435
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1436
 
 
1437
    def open(self, a_bzrdir, _found=False):
 
1438
        """Return the WorkingTree object for a_bzrdir
 
1439
 
 
1440
        _found is a private parameter, do not use it. It is used to indicate
 
1441
               if format probing has already been done.
 
1442
        """
 
1443
        if not _found:
 
1444
            # we are being called directly and must probe.
 
1445
            raise NotImplementedError
 
1446
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1447
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1448
        return WorkingTree(a_bzrdir.root_transport.base,
 
1449
                           _internal=True,
 
1450
                           _format=self,
 
1451
                           _bzrdir=a_bzrdir)
 
1452
 
 
1453
 
 
1454
class WorkingTreeFormat3(WorkingTreeFormat):
 
1455
    """The second working tree format updated to record a format marker.
 
1456
 
 
1457
    This format:
 
1458
        - exists within a metadir controlling .bzr
 
1459
        - includes an explicit version marker for the workingtree control
 
1460
          files, separate from the BzrDir format
 
1461
        - modifies the hash cache format
 
1462
        - is new in bzr 0.8
 
1463
        - uses a LockDir to guard access to the repository
 
1464
    """
 
1465
 
 
1466
    def get_format_string(self):
 
1467
        """See WorkingTreeFormat.get_format_string()."""
 
1468
        return "Bazaar-NG Working Tree format 3"
 
1469
 
 
1470
    _lock_file_name = 'lock'
 
1471
    _lock_class = LockDir
 
1472
 
 
1473
    def _open_control_files(self, a_bzrdir):
 
1474
        transport = a_bzrdir.get_workingtree_transport(None)
 
1475
        return LockableFiles(transport, self._lock_file_name, 
 
1476
                             self._lock_class)
 
1477
 
 
1478
    def initialize(self, a_bzrdir, revision_id=None):
 
1479
        """See WorkingTreeFormat.initialize().
 
1480
        
 
1481
        revision_id allows creating a working tree at a differnet
 
1482
        revision than the branch is at.
 
1483
        """
 
1484
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1485
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1486
        transport = a_bzrdir.get_workingtree_transport(self)
 
1487
        control_files = self._open_control_files(a_bzrdir)
 
1488
        control_files.create_lock()
 
1489
        control_files.put_utf8('format', self.get_format_string())
 
1490
        branch = a_bzrdir.open_branch()
 
1491
        if revision_id is None:
 
1492
            revision_id = branch.last_revision()
 
1493
        inv = Inventory() 
 
1494
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
1495
                         branch,
 
1496
                         inv,
 
1497
                         _internal=True,
 
1498
                         _format=self,
 
1499
                         _bzrdir=a_bzrdir,
 
1500
                         _control_files=control_files)
 
1501
        wt._write_inventory(inv)
 
1502
        wt.set_root_id(inv.root.file_id)
 
1503
        wt.set_last_revision(revision_id)
 
1504
        wt.set_pending_merges([])
 
1505
        build_tree(wt.basis_tree(), wt)
 
1506
        return wt
 
1507
 
 
1508
    def __init__(self):
 
1509
        super(WorkingTreeFormat3, self).__init__()
 
1510
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1511
 
 
1512
    def open(self, a_bzrdir, _found=False):
 
1513
        """Return the WorkingTree object for a_bzrdir
 
1514
 
 
1515
        _found is a private parameter, do not use it. It is used to indicate
 
1516
               if format probing has already been done.
 
1517
        """
 
1518
        if not _found:
 
1519
            # we are being called directly and must probe.
 
1520
            raise NotImplementedError
 
1521
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1522
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1523
        control_files = self._open_control_files(a_bzrdir)
 
1524
        return WorkingTree3(a_bzrdir.root_transport.base,
 
1525
                           _internal=True,
 
1526
                           _format=self,
 
1527
                           _bzrdir=a_bzrdir,
 
1528
                           _control_files=control_files)
 
1529
 
 
1530
    def __str__(self):
 
1531
        return self.get_format_string()
 
1532
 
 
1533
 
 
1534
# formats which have no format string are not discoverable
 
1535
# and not independently creatable, so are not registered.
 
1536
__default_format = WorkingTreeFormat3()
 
1537
WorkingTreeFormat.register_format(__default_format)
 
1538
WorkingTreeFormat.set_default_format(__default_format)
 
1539
_legacy_formats = [WorkingTreeFormat2(),
 
1540
                   ]
 
1541
 
 
1542
 
 
1543
class WorkingTreeTestProviderAdapter(object):
 
1544
    """A tool to generate a suite testing multiple workingtree formats at once.
 
1545
 
 
1546
    This is done by copying the test once for each transport and injecting
 
1547
    the transport_server, transport_readonly_server, and workingtree_format
 
1548
    classes into each copy. Each copy is also given a new id() to make it
 
1549
    easy to identify.
 
1550
    """
 
1551
 
 
1552
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1553
        self._transport_server = transport_server
 
1554
        self._transport_readonly_server = transport_readonly_server
 
1555
        self._formats = formats
 
1556
    
 
1557
    def adapt(self, test):
 
1558
        from bzrlib.tests import TestSuite
 
1559
        result = TestSuite()
 
1560
        for workingtree_format, bzrdir_format in self._formats:
 
1561
            new_test = deepcopy(test)
 
1562
            new_test.transport_server = self._transport_server
 
1563
            new_test.transport_readonly_server = self._transport_readonly_server
 
1564
            new_test.bzrdir_format = bzrdir_format
 
1565
            new_test.workingtree_format = workingtree_format
 
1566
            def make_new_test_id():
 
1567
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
 
1568
                return lambda: new_id
 
1569
            new_test.id = make_new_test_id()
 
1570
            result.addTest(new_test)
 
1571
        return result