/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2006-04-13 05:37:24 UTC
  • mto: This revision was merged to the branch mainline in revision 1662.
  • Revision ID: mbp@sourcefrog.net-20060413053724-8c0053ac31492637
Give an error for bzr diff on an nonexistent file (Malone #3619)

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