~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: abentley
  • Date: 2005-10-14 03:50:50 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1460.
  • Revision ID: abentley@lappy-20051014035050-d779472ccb599a51
semi-broke merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""WorkingTree object and friends.
18
 
 
19
 
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here, 
21
 
such as renaming or adding files.  The WorkingTree has an inventory 
22
 
which is updated by these operations.  A commit produces a 
23
 
new revision based on the workingtree and its inventory.
24
 
 
25
 
At the moment every WorkingTree has its own branch.  Remote
26
 
WorkingTrees aren't supported.
27
 
 
28
 
To get a WorkingTree, call bzrdir.open_workingtree() or
29
 
WorkingTree.open(dir).
30
 
"""
31
 
 
32
 
# TODO: Give the workingtree sole responsibility for the working inventory;
33
 
# remove the variable and references to it from the branch.  This may require
34
 
# updating the commit code so as to update the inventory within the working
35
 
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
 
# At the moment they may alias the inventory and have old copies of it in
37
 
# memory.  (Now done? -- mbp 20060309)
38
 
 
39
 
from cStringIO import StringIO
 
17
# TODO: Don't allow WorkingTrees to be constructed for remote branches.
 
18
 
 
19
# FIXME: I don't know if writing out the cache from the destructor is really a
 
20
# good idea, because destructors are considered poor taste in Python, and
 
21
# it's not predictable when it will be written out.
 
22
 
40
23
import os
41
 
import sys
42
 
 
43
 
from bzrlib.lazy_import import lazy_import
44
 
lazy_import(globals(), """
45
 
from bisect import bisect_left
46
 
import collections
47
 
import errno
48
 
import itertools
49
 
import operator
50
24
import stat
51
 
from time import time
52
 
import warnings
53
 
import re
54
 
 
55
 
import bzrlib
56
 
from bzrlib import (
57
 
    branch,
58
 
    bzrdir,
59
 
    conflicts as _mod_conflicts,
60
 
    dirstate,
61
 
    errors,
62
 
    generate_ids,
63
 
    globbing,
64
 
    hashcache,
65
 
    ignores,
66
 
    merge,
67
 
    osutils,
68
 
    revision as _mod_revision,
69
 
    revisiontree,
70
 
    repository,
71
 
    textui,
72
 
    trace,
73
 
    transform,
74
 
    ui,
75
 
    urlutils,
76
 
    xml5,
77
 
    xml6,
78
 
    xml7,
79
 
    )
80
 
import bzrlib.branch
81
 
from bzrlib.transport import get_transport
82
 
import bzrlib.ui
83
 
from bzrlib.workingtree_4 import WorkingTreeFormat4
84
 
""")
85
 
 
86
 
from bzrlib import symbol_versioning
87
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
 
from bzrlib.lockable_files import LockableFiles, TransportLock
90
 
from bzrlib.lockdir import LockDir
91
 
import bzrlib.mutabletree
92
 
from bzrlib.mutabletree import needs_tree_write_lock
93
 
from bzrlib.osutils import (
94
 
    compact_date,
95
 
    file_kind,
96
 
    isdir,
97
 
    normpath,
98
 
    pathjoin,
99
 
    rand_chars,
100
 
    realpath,
101
 
    safe_unicode,
102
 
    splitpath,
103
 
    supports_executable,
104
 
    )
105
 
from bzrlib.trace import mutter, note
106
 
from bzrlib.transport.local import LocalTransport
107
 
from bzrlib.progress import DummyProgress, ProgressPhase
108
 
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
 
from bzrlib.rio import RioReader, rio_file, Stanza
110
 
from bzrlib.symbol_versioning import (deprecated_passed,
111
 
        deprecated_method,
112
 
        deprecated_function,
113
 
        DEPRECATED_PARAMETER,
114
 
        zero_eight,
115
 
        zero_eleven,
116
 
        zero_thirteen,
117
 
        )
118
 
 
119
 
 
120
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
122
 
 
123
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
124
 
 
125
 
 
126
 
@deprecated_function(zero_thirteen)
127
 
def gen_file_id(name):
128
 
    """Return new file id for the basename 'name'.
129
 
 
130
 
    Use bzrlib.generate_ids.gen_file_id() instead
131
 
    """
132
 
    return generate_ids.gen_file_id(name)
133
 
 
134
 
 
135
 
@deprecated_function(zero_thirteen)
136
 
def gen_root_id():
137
 
    """Return a new tree-root file id.
138
 
 
139
 
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
140
 
    """
141
 
    return generate_ids.gen_root_id()
142
 
 
 
25
import fnmatch
 
26
        
 
27
import bzrlib.tree
 
28
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
 
29
from bzrlib.errors import BzrCheckError
 
30
from bzrlib.trace import mutter
143
31
 
144
32
class TreeEntry(object):
145
 
    """An entry that implements the minimum interface used by commands.
 
33
    """An entry that implements the minium interface used by commands.
146
34
 
147
35
    This needs further inspection, it may be better to have 
148
36
    InventoryEntries without ids - though that seems wrong. For now,
196
84
        return ''
197
85
 
198
86
 
199
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
87
class WorkingTree(bzrlib.tree.Tree):
200
88
    """Working copy tree.
201
89
 
202
90
    The inventory is held in the `Branch` working-inventory, and the
205
93
    It is possible for a `WorkingTree` to have a filename which is
206
94
    not listed in the Inventory and vice versa.
207
95
    """
208
 
 
209
 
    def __init__(self, basedir='.',
210
 
                 branch=DEPRECATED_PARAMETER,
211
 
                 _inventory=None,
212
 
                 _control_files=None,
213
 
                 _internal=False,
214
 
                 _format=None,
215
 
                 _bzrdir=None):
216
 
        """Construct a WorkingTree instance. This is not a public API.
217
 
 
218
 
        :param branch: A branch to override probing for the branch.
219
 
        """
220
 
        self._format = _format
221
 
        self.bzrdir = _bzrdir
222
 
        if not _internal:
223
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
 
                "WorkingTree.open() to obtain a WorkingTree.")
225
 
        assert isinstance(basedir, basestring), \
226
 
            "base directory %r is not a string" % basedir
227
 
        basedir = safe_unicode(basedir)
228
 
        mutter("opening working tree %r", basedir)
229
 
        if deprecated_passed(branch):
230
 
            self._branch = branch
231
 
        else:
232
 
            self._branch = self.bzrdir.open_branch()
233
 
        self.basedir = realpath(basedir)
234
 
        # if branch is at our basedir and is a format 6 or less
235
 
        if isinstance(self._format, WorkingTreeFormat2):
236
 
            # share control object
237
 
            self._control_files = self.branch.control_files
238
 
        else:
239
 
            # assume all other formats have their own control files.
240
 
            assert isinstance(_control_files, LockableFiles), \
241
 
                    "_control_files must be a LockableFiles, not %r" \
242
 
                    % _control_files
243
 
            self._control_files = _control_files
 
96
    def __init__(self, basedir, inv):
 
97
        from bzrlib.hashcache import HashCache
 
98
        from bzrlib.trace import note, mutter
 
99
 
 
100
        self._inventory = inv
 
101
        self.basedir = basedir
 
102
        self.path2id = inv.path2id
 
103
 
244
104
        # update the whole cache up front and write to disk if anything changed;
245
105
        # in the future we might want to do this more selectively
246
 
        # two possible ways offer themselves : in self._unlock, write the cache
247
 
        # if needed, or, when the cache sees a change, append it to the hash
248
 
        # cache file, and have the parser take the most recent entry for a
249
 
        # given path only.
250
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
251
 
        cache_filename = wt_trans.local_abspath('stat-cache')
252
 
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
 
                                              self._control_files._file_mode)
254
 
        hc = self._hashcache
 
106
        hc = self._hashcache = HashCache(basedir)
255
107
        hc.read()
256
 
        # is this scan needed ? it makes things kinda slow.
257
 
        #hc.scan()
 
108
        hc.scan()
258
109
 
259
110
        if hc.needs_write:
260
111
            mutter("write hc")
261
112
            hc.write()
262
 
 
263
 
        if _inventory is None:
264
 
            # This will be acquired on lock_read() or lock_write()
265
 
            self._inventory_is_modified = False
266
 
            self._inventory = None
267
 
        else:
268
 
            # the caller of __init__ has provided an inventory,
269
 
            # we assume they know what they are doing - as its only
270
 
            # the Format factory and creation methods that are
271
 
            # permitted to do this.
272
 
            self._set_inventory(_inventory, dirty=False)
273
 
 
274
 
    branch = property(
275
 
        fget=lambda self: self._branch,
276
 
        doc="""The branch this WorkingTree is connected to.
277
 
 
278
 
            This cannot be set - it is reflective of the actual disk structure
279
 
            the working tree has been constructed from.
280
 
            """)
281
 
 
282
 
    def break_lock(self):
283
 
        """Break a lock if one is present from another instance.
284
 
 
285
 
        Uses the ui factory to ask for confirmation if the lock may be from
286
 
        an active process.
287
 
 
288
 
        This will probe the repository for its lock as well.
289
 
        """
290
 
        self._control_files.break_lock()
291
 
        self.branch.break_lock()
292
 
 
293
 
    def requires_rich_root(self):
294
 
        return self._format.requires_rich_root
295
 
 
296
 
    def supports_tree_reference(self):
297
 
        return False
298
 
 
299
 
    def _set_inventory(self, inv, dirty):
300
 
        """Set the internal cached inventory.
301
 
 
302
 
        :param inv: The inventory to set.
303
 
        :param dirty: A boolean indicating whether the inventory is the same
304
 
            logical inventory as whats on disk. If True the inventory is not
305
 
            the same and should be written to disk or data will be lost, if
306
 
            False then the inventory is the same as that on disk and any
307
 
            serialisation would be unneeded overhead.
308
 
        """
309
 
        assert inv.root is not None
310
 
        self._inventory = inv
311
 
        self._inventory_is_modified = dirty
312
 
 
313
 
    @staticmethod
314
 
    def open(path=None, _unsupported=False):
315
 
        """Open an existing working tree at path.
316
 
 
317
 
        """
318
 
        if path is None:
319
 
            path = os.path.getcwdu()
320
 
        control = bzrdir.BzrDir.open(path, _unsupported)
321
 
        return control.open_workingtree(_unsupported)
322
 
        
323
 
    @staticmethod
324
 
    def open_containing(path=None):
325
 
        """Open an existing working tree which has its root about path.
326
 
        
327
 
        This probes for a working tree at path and searches upwards from there.
328
 
 
329
 
        Basically we keep looking up until we find the control directory or
330
 
        run into /.  If there isn't one, raises NotBranchError.
331
 
        TODO: give this a new exception.
332
 
        If there is one, it is returned, along with the unused portion of path.
333
 
 
334
 
        :return: The WorkingTree that contains 'path', and the rest of path
335
 
        """
336
 
        if path is None:
337
 
            path = osutils.getcwd()
338
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
339
 
 
340
 
        return control.open_workingtree(), relpath
341
 
 
342
 
    @staticmethod
343
 
    def open_downlevel(path=None):
344
 
        """Open an unsupported working tree.
345
 
 
346
 
        Only intended for advanced situations like upgrading part of a bzrdir.
347
 
        """
348
 
        return WorkingTree.open(path, _unsupported=True)
349
 
 
350
 
    # should be deprecated - this is slow and in any case treating them as a
351
 
    # container is (we now know) bad style -- mbp 20070302
352
 
    ## @deprecated_method(zero_fifteen)
 
113
            
 
114
            
 
115
    def __del__(self):
 
116
        if self._hashcache.needs_write:
 
117
            self._hashcache.write()
 
118
 
 
119
 
353
120
    def __iter__(self):
354
121
        """Iterate through file_ids for this tree.
355
122
 
358
125
        """
359
126
        inv = self._inventory
360
127
        for path, ie in inv.iter_entries():
361
 
            if osutils.lexists(self.abspath(path)):
 
128
            if bzrlib.osutils.lexists(self.abspath(path)):
362
129
                yield ie.file_id
363
130
 
 
131
 
364
132
    def __repr__(self):
365
133
        return "<%s of %s>" % (self.__class__.__name__,
366
134
                               getattr(self, 'basedir', None))
367
135
 
 
136
 
 
137
 
368
138
    def abspath(self, filename):
369
 
        return pathjoin(self.basedir, filename)
370
 
 
371
 
    def basis_tree(self):
372
 
        """Return RevisionTree for the current last revision.
373
 
        
374
 
        If the left most parent is a ghost then the returned tree will be an
375
 
        empty tree - one obtained by calling repository.revision_tree(None).
376
 
        """
377
 
        try:
378
 
            revision_id = self.get_parent_ids()[0]
379
 
        except IndexError:
380
 
            # no parents, return an empty revision tree.
381
 
            # in the future this should return the tree for
382
 
            # 'empty:' - the implicit root empty tree.
383
 
            return self.branch.repository.revision_tree(None)
384
 
        try:
385
 
            return self.revision_tree(revision_id)
386
 
        except errors.NoSuchRevision:
387
 
            pass
388
 
        # No cached copy available, retrieve from the repository.
389
 
        # FIXME? RBC 20060403 should we cache the inventory locally
390
 
        # at this point ?
391
 
        try:
392
 
            return self.branch.repository.revision_tree(revision_id)
393
 
        except errors.RevisionNotPresent:
394
 
            # the basis tree *may* be a ghost or a low level error may have
395
 
            # occured. If the revision is present, its a problem, if its not
396
 
            # its a ghost.
397
 
            if self.branch.repository.has_revision(revision_id):
398
 
                raise
399
 
            # the basis tree is a ghost so return an empty tree.
400
 
            return self.branch.repository.revision_tree(None)
401
 
 
402
 
    @staticmethod
403
 
    @deprecated_method(zero_eight)
404
 
    def create(branch, directory):
405
 
        """Create a workingtree for branch at directory.
406
 
 
407
 
        If existing_directory already exists it must have a .bzr directory.
408
 
        If it does not exist, it will be created.
409
 
 
410
 
        This returns a new WorkingTree object for the new checkout.
411
 
 
412
 
        TODO FIXME RBC 20060124 when we have checkout formats in place this
413
 
        should accept an optional revisionid to checkout [and reject this if
414
 
        checking out into the same dir as a pre-checkout-aware branch format.]
415
 
 
416
 
        XXX: When BzrDir is present, these should be created through that 
417
 
        interface instead.
418
 
        """
419
 
        warnings.warn('delete WorkingTree.create', stacklevel=3)
420
 
        transport = get_transport(directory)
421
 
        if branch.bzrdir.root_transport.base == transport.base:
422
 
            # same dir 
423
 
            return branch.bzrdir.create_workingtree()
424
 
        # different directory, 
425
 
        # create a branch reference
426
 
        # and now a working tree.
427
 
        raise NotImplementedError
428
 
 
429
 
    @staticmethod
430
 
    @deprecated_method(zero_eight)
431
 
    def create_standalone(directory):
432
 
        """Create a checkout and a branch and a repo at directory.
433
 
 
434
 
        Directory must exist and be empty.
435
 
 
436
 
        please use BzrDir.create_standalone_workingtree
437
 
        """
438
 
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
 
 
440
 
    def relpath(self, path):
441
 
        """Return the local path portion from a given path.
442
 
        
443
 
        The path may be absolute or relative. If its a relative path it is 
444
 
        interpreted relative to the python current working directory.
445
 
        """
446
 
        return osutils.relpath(self.basedir, path)
 
139
        return os.path.join(self.basedir, filename)
447
140
 
448
141
    def has_filename(self, filename):
449
 
        return osutils.lexists(self.abspath(filename))
 
142
        return bzrlib.osutils.lexists(self.abspath(filename))
450
143
 
451
144
    def get_file(self, file_id):
452
 
        file_id = osutils.safe_file_id(file_id)
453
145
        return self.get_file_byname(self.id2path(file_id))
454
146
 
455
 
    def get_file_text(self, file_id):
456
 
        file_id = osutils.safe_file_id(file_id)
457
 
        return self.get_file(file_id).read()
458
 
 
459
147
    def get_file_byname(self, filename):
460
148
        return file(self.abspath(filename), 'rb')
461
149
 
462
 
    @needs_read_lock
463
 
    def annotate_iter(self, file_id):
464
 
        """See Tree.annotate_iter
465
 
 
466
 
        This implementation will use the basis tree implementation if possible.
467
 
        Lines not in the basis are attributed to CURRENT_REVISION
468
 
 
469
 
        If there are pending merges, lines added by those merges will be
470
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
471
 
        attribution will be correct).
472
 
        """
473
 
        file_id = osutils.safe_file_id(file_id)
474
 
        basis = self.basis_tree()
475
 
        basis.lock_read()
476
 
        try:
477
 
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
478
 
                require_versioned=True).next()
479
 
            changed_content, kind = changes[2], changes[6]
480
 
            if not changed_content:
481
 
                return basis.annotate_iter(file_id)
482
 
            if kind[1] is None:
483
 
                return None
484
 
            import annotate
485
 
            if kind[0] != 'file':
486
 
                old_lines = []
487
 
            else:
488
 
                old_lines = list(basis.annotate_iter(file_id))
489
 
            old = [old_lines]
490
 
            for tree in self.branch.repository.revision_trees(
491
 
                self.get_parent_ids()[1:]):
492
 
                if file_id not in tree:
493
 
                    continue
494
 
                old.append(list(tree.annotate_iter(file_id)))
495
 
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
496
 
                                       CURRENT_REVISION)
497
 
        finally:
498
 
            basis.unlock()
499
 
 
500
 
    def get_parent_ids(self):
501
 
        """See Tree.get_parent_ids.
502
 
        
503
 
        This implementation reads the pending merges list and last_revision
504
 
        value and uses that to decide what the parents list should be.
505
 
        """
506
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
507
 
        if _mod_revision.NULL_REVISION == last_rev:
508
 
            parents = []
509
 
        else:
510
 
            parents = [last_rev]
511
 
        try:
512
 
            merges_file = self._control_files.get('pending-merges')
513
 
        except errors.NoSuchFile:
514
 
            pass
515
 
        else:
516
 
            for l in merges_file.readlines():
517
 
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
518
 
                parents.append(revision_id)
519
 
        return parents
520
 
 
521
 
    @needs_read_lock
522
 
    def get_root_id(self):
523
 
        """Return the id of this trees root"""
524
 
        return self._inventory.root.file_id
525
 
        
526
150
    def _get_store_filename(self, file_id):
527
 
        ## XXX: badly named; this is not in the store at all
528
 
        file_id = osutils.safe_file_id(file_id)
 
151
        ## XXX: badly named; this isn't in the store at all
529
152
        return self.abspath(self.id2path(file_id))
530
153
 
531
 
    @needs_read_lock
532
 
    def clone(self, to_bzrdir, revision_id=None):
533
 
        """Duplicate this working tree into to_bzr, including all state.
534
 
        
535
 
        Specifically modified files are kept as modified, but
536
 
        ignored and unknown files are discarded.
537
 
 
538
 
        If you want to make a new line of development, see bzrdir.sprout()
539
 
 
540
 
        revision
541
 
            If not None, the cloned tree will have its last revision set to 
542
 
            revision, and and difference between the source trees last revision
543
 
            and this one merged in.
544
 
        """
545
 
        # assumes the target bzr dir format is compatible.
546
 
        result = self._format.initialize(to_bzrdir)
547
 
        self.copy_content_into(result, revision_id)
548
 
        return result
549
 
 
550
 
    @needs_read_lock
551
 
    def copy_content_into(self, tree, revision_id=None):
552
 
        """Copy the current content and user files of this tree into tree."""
553
 
        tree.set_root_id(self.get_root_id())
554
 
        if revision_id is None:
555
 
            merge.transform_tree(tree, self)
556
 
        else:
557
 
            # TODO now merge from tree.last_revision to revision (to preserve
558
 
            # user local changes)
559
 
            merge.transform_tree(tree, self)
560
 
            tree.set_parent_ids([revision_id])
561
154
 
562
155
    def id2abspath(self, file_id):
563
 
        file_id = osutils.safe_file_id(file_id)
564
156
        return self.abspath(self.id2path(file_id))
565
157
 
566
 
    def has_id(self, file_id):
 
158
                
 
159
    def has_id(self, file_id, allow_root=False):
567
160
        # files that have been deleted are excluded
568
 
        file_id = osutils.safe_file_id(file_id)
569
161
        inv = self.inventory
 
162
        if allow_root and file_id == inv.root.file_id:
 
163
            return True
570
164
        if not inv.has_id(file_id):
571
165
            return False
572
166
        path = inv.id2path(file_id)
573
 
        return osutils.lexists(self.abspath(path))
 
167
        return bzrlib.osutils.lexists(self.abspath(path))
574
168
 
575
 
    def has_or_had_id(self, file_id):
576
 
        file_id = osutils.safe_file_id(file_id)
577
 
        if file_id == self.inventory.root.file_id:
578
 
            return True
579
 
        return self.inventory.has_id(file_id)
580
169
 
581
170
    __contains__ = has_id
 
171
    
582
172
 
583
173
    def get_file_size(self, file_id):
584
 
        file_id = osutils.safe_file_id(file_id)
585
174
        return os.path.getsize(self.id2abspath(file_id))
586
175
 
587
 
    @needs_read_lock
588
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
589
 
        file_id = osutils.safe_file_id(file_id)
590
 
        if not path:
 
176
    def get_file_sha1(self, file_id):
 
177
        path = self._inventory.id2path(file_id)
 
178
        return self._hashcache.get_sha1(path)
 
179
 
 
180
 
 
181
    def is_executable(self, file_id):
 
182
        if os.name == "nt":
 
183
            return self._inventory[file_id].executable
 
184
        else:
591
185
            path = self._inventory.id2path(file_id)
592
 
        return self._hashcache.get_sha1(path, stat_value)
593
 
 
594
 
    def get_file_mtime(self, file_id, path=None):
595
 
        file_id = osutils.safe_file_id(file_id)
596
 
        if not path:
597
 
            path = self.inventory.id2path(file_id)
598
 
        return os.lstat(self.abspath(path)).st_mtime
599
 
 
600
 
    if not supports_executable():
601
 
        def is_executable(self, file_id, path=None):
602
 
            file_id = osutils.safe_file_id(file_id)
603
 
            return self._inventory[file_id].executable
604
 
    else:
605
 
        def is_executable(self, file_id, path=None):
606
 
            if not path:
607
 
                file_id = osutils.safe_file_id(file_id)
608
 
                path = self.id2path(file_id)
609
186
            mode = os.lstat(self.abspath(path)).st_mode
610
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
611
 
 
612
 
    @needs_tree_write_lock
613
 
    def _add(self, files, ids, kinds):
614
 
        """See MutableTree._add."""
615
 
        # TODO: Re-adding a file that is removed in the working copy
616
 
        # should probably put it back with the previous ID.
617
 
        # the read and write working inventory should not occur in this 
618
 
        # function - they should be part of lock_write and unlock.
619
 
        inv = self.inventory
620
 
        for f, file_id, kind in zip(files, ids, kinds):
621
 
            assert kind is not None
622
 
            if file_id is None:
623
 
                inv.add_path(f, kind=kind)
624
 
            else:
625
 
                file_id = osutils.safe_file_id(file_id)
626
 
                inv.add_path(f, kind=kind, file_id=file_id)
627
 
            self._inventory_is_modified = True
628
 
 
629
 
    @needs_tree_write_lock
630
 
    def _gather_kinds(self, files, kinds):
631
 
        """See MutableTree._gather_kinds."""
632
 
        for pos, f in enumerate(files):
633
 
            if kinds[pos] is None:
634
 
                fullpath = normpath(self.abspath(f))
635
 
                try:
636
 
                    kinds[pos] = file_kind(fullpath)
637
 
                except OSError, e:
638
 
                    if e.errno == errno.ENOENT:
639
 
                        raise errors.NoSuchFile(fullpath)
640
 
 
641
 
    @needs_write_lock
642
 
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
643
 
        """Add revision_id as a parent.
644
 
 
645
 
        This is equivalent to retrieving the current list of parent ids
646
 
        and setting the list to its value plus revision_id.
647
 
 
648
 
        :param revision_id: The revision id to add to the parent list. It may
649
 
        be a ghost revision as long as its not the first parent to be added,
650
 
        or the allow_leftmost_as_ghost parameter is set True.
651
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
652
 
        """
653
 
        parents = self.get_parent_ids() + [revision_id]
654
 
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
655
 
            or allow_leftmost_as_ghost)
656
 
 
657
 
    @needs_tree_write_lock
658
 
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
659
 
        """Add revision_id, tree tuple as a parent.
660
 
 
661
 
        This is equivalent to retrieving the current list of parent trees
662
 
        and setting the list to its value plus parent_tuple. See also
663
 
        add_parent_tree_id - if you only have a parent id available it will be
664
 
        simpler to use that api. If you have the parent already available, using
665
 
        this api is preferred.
666
 
 
667
 
        :param parent_tuple: The (revision id, tree) to add to the parent list.
668
 
            If the revision_id is a ghost, pass None for the tree.
669
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
670
 
        """
671
 
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
672
 
        if len(parent_ids) > 1:
673
 
            # the leftmost may have already been a ghost, preserve that if it
674
 
            # was.
675
 
            allow_leftmost_as_ghost = True
676
 
        self.set_parent_ids(parent_ids,
677
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
678
 
 
679
 
    @needs_tree_write_lock
680
 
    def add_pending_merge(self, *revision_ids):
681
 
        # TODO: Perhaps should check at this point that the
682
 
        # history of the revision is actually present?
683
 
        parents = self.get_parent_ids()
684
 
        updated = False
685
 
        for rev_id in revision_ids:
686
 
            if rev_id in parents:
687
 
                continue
688
 
            parents.append(rev_id)
689
 
            updated = True
690
 
        if updated:
691
 
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
692
 
 
693
 
    @deprecated_method(zero_eleven)
694
 
    @needs_read_lock
695
 
    def pending_merges(self):
696
 
        """Return a list of pending merges.
697
 
 
698
 
        These are revisions that have been merged into the working
699
 
        directory but not yet committed.
700
 
 
701
 
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
702
 
        instead - which is available on all tree objects.
703
 
        """
704
 
        return self.get_parent_ids()[1:]
705
 
 
706
 
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
707
 
        """Common ghost checking functionality from set_parent_*.
708
 
 
709
 
        This checks that the left hand-parent exists if there are any
710
 
        revisions present.
711
 
        """
712
 
        if len(revision_ids) > 0:
713
 
            leftmost_id = revision_ids[0]
714
 
            if (not allow_leftmost_as_ghost and not
715
 
                self.branch.repository.has_revision(leftmost_id)):
716
 
                raise errors.GhostRevisionUnusableHere(leftmost_id)
717
 
 
718
 
    def _set_merges_from_parent_ids(self, parent_ids):
719
 
        merges = parent_ids[1:]
720
 
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
721
 
 
722
 
    @needs_tree_write_lock
723
 
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
724
 
        """Set the parent ids to revision_ids.
725
 
        
726
 
        See also set_parent_trees. This api will try to retrieve the tree data
727
 
        for each element of revision_ids from the trees repository. If you have
728
 
        tree data already available, it is more efficient to use
729
 
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
730
 
        an easier API to use.
731
 
 
732
 
        :param revision_ids: The revision_ids to set as the parent ids of this
733
 
            working tree. Any of these may be ghosts.
734
 
        """
735
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
736
 
        self._check_parents_for_ghosts(revision_ids,
737
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
738
 
        for revision_id in revision_ids:
739
 
            _mod_revision.check_not_reserved_id(revision_id)
740
 
 
741
 
        if len(revision_ids) > 0:
742
 
            self.set_last_revision(revision_ids[0])
743
 
        else:
744
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
745
 
 
746
 
        self._set_merges_from_parent_ids(revision_ids)
747
 
 
748
 
    @needs_tree_write_lock
749
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
750
 
        """See MutableTree.set_parent_trees."""
751
 
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
752
 
        for revision_id in parent_ids:
753
 
            _mod_revision.check_not_reserved_id(revision_id)
754
 
 
755
 
        self._check_parents_for_ghosts(parent_ids,
756
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
757
 
 
758
 
        if len(parent_ids) == 0:
759
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
760
 
            leftmost_parent_tree = None
761
 
        else:
762
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
763
 
 
764
 
        if self._change_last_revision(leftmost_parent_id):
765
 
            if leftmost_parent_tree is None:
766
 
                # If we don't have a tree, fall back to reading the
767
 
                # parent tree from the repository.
768
 
                self._cache_basis_inventory(leftmost_parent_id)
769
 
            else:
770
 
                inv = leftmost_parent_tree.inventory
771
 
                xml = self._create_basis_xml_from_inventory(
772
 
                                        leftmost_parent_id, inv)
773
 
                self._write_basis_inventory(xml)
774
 
        self._set_merges_from_parent_ids(parent_ids)
775
 
 
776
 
    @needs_tree_write_lock
777
 
    def set_pending_merges(self, rev_list):
778
 
        parents = self.get_parent_ids()
779
 
        leftmost = parents[:1]
780
 
        new_parents = leftmost + rev_list
781
 
        self.set_parent_ids(new_parents)
782
 
 
783
 
    @needs_tree_write_lock
784
 
    def set_merge_modified(self, modified_hashes):
785
 
        def iter_stanzas():
786
 
            for file_id, hash in modified_hashes.iteritems():
787
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
788
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
789
 
 
790
 
    def _put_rio(self, filename, stanzas, header):
791
 
        self._must_be_locked()
792
 
        my_file = rio_file(stanzas, header)
793
 
        self._control_files.put(filename, my_file)
794
 
 
795
 
    @needs_write_lock # because merge pulls data into the branch.
796
 
    def merge_from_branch(self, branch, to_revision=None):
797
 
        """Merge from a branch into this working tree.
798
 
 
799
 
        :param branch: The branch to merge from.
800
 
        :param to_revision: If non-None, the merge will merge to to_revision,
801
 
            but not beyond it. to_revision does not need to be in the history
802
 
            of the branch when it is supplied. If None, to_revision defaults to
803
 
            branch.last_revision().
804
 
        """
805
 
        from bzrlib.merge import Merger, Merge3Merger
806
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
807
 
        try:
808
 
            merger = Merger(self.branch, this_tree=self, pb=pb)
809
 
            merger.pp = ProgressPhase("Merge phase", 5, pb)
810
 
            merger.pp.next_phase()
811
 
            # check that there are no
812
 
            # local alterations
813
 
            merger.check_basis(check_clean=True, require_commits=False)
814
 
            if to_revision is None:
815
 
                to_revision = _mod_revision.ensure_null(branch.last_revision())
816
 
            else:
817
 
                to_revision = osutils.safe_revision_id(to_revision)
818
 
            merger.other_rev_id = to_revision
819
 
            if _mod_revision.is_null(merger.other_rev_id):
820
 
                raise errors.NoCommits(branch)
821
 
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
822
 
            merger.other_basis = merger.other_rev_id
823
 
            merger.other_tree = self.branch.repository.revision_tree(
824
 
                merger.other_rev_id)
825
 
            merger.other_branch = branch
826
 
            merger.pp.next_phase()
827
 
            merger.find_base()
828
 
            if merger.base_rev_id == merger.other_rev_id:
829
 
                raise errors.PointlessMerge
830
 
            merger.backup_files = False
831
 
            merger.merge_type = Merge3Merger
832
 
            merger.set_interesting_files(None)
833
 
            merger.show_base = False
834
 
            merger.reprocess = False
835
 
            conflicts = merger.do_merge()
836
 
            merger.set_pending()
837
 
        finally:
838
 
            pb.finished()
839
 
        return conflicts
840
 
 
841
 
    @needs_read_lock
842
 
    def merge_modified(self):
843
 
        """Return a dictionary of files modified by a merge.
844
 
 
845
 
        The list is initialized by WorkingTree.set_merge_modified, which is 
846
 
        typically called after we make some automatic updates to the tree
847
 
        because of a merge.
848
 
 
849
 
        This returns a map of file_id->sha1, containing only files which are
850
 
        still in the working inventory and have that text hash.
851
 
        """
852
 
        try:
853
 
            hashfile = self._control_files.get('merge-hashes')
854
 
        except errors.NoSuchFile:
855
 
            return {}
856
 
        merge_hashes = {}
857
 
        try:
858
 
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
859
 
                raise errors.MergeModifiedFormatError()
860
 
        except StopIteration:
861
 
            raise errors.MergeModifiedFormatError()
862
 
        for s in RioReader(hashfile):
863
 
            # RioReader reads in Unicode, so convert file_ids back to utf8
864
 
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
865
 
            if file_id not in self.inventory:
866
 
                continue
867
 
            text_hash = s.get("hash")
868
 
            if text_hash == self.get_file_sha1(file_id):
869
 
                merge_hashes[file_id] = text_hash
870
 
        return merge_hashes
871
 
 
872
 
    @needs_write_lock
873
 
    def mkdir(self, path, file_id=None):
874
 
        """See MutableTree.mkdir()."""
875
 
        if file_id is None:
876
 
            file_id = generate_ids.gen_file_id(os.path.basename(path))
877
 
        os.mkdir(self.abspath(path))
878
 
        self.add(path, file_id, 'directory')
879
 
        return file_id
 
187
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
880
188
 
881
189
    def get_symlink_target(self, file_id):
882
 
        file_id = osutils.safe_file_id(file_id)
883
190
        return os.readlink(self.id2abspath(file_id))
884
191
 
885
 
    @needs_write_lock
886
 
    def subsume(self, other_tree):
887
 
        def add_children(inventory, entry):
888
 
            for child_entry in entry.children.values():
889
 
                inventory._byid[child_entry.file_id] = child_entry
890
 
                if child_entry.kind == 'directory':
891
 
                    add_children(inventory, child_entry)
892
 
        if other_tree.get_root_id() == self.get_root_id():
893
 
            raise errors.BadSubsumeSource(self, other_tree,
894
 
                                          'Trees have the same root')
895
 
        try:
896
 
            other_tree_path = self.relpath(other_tree.basedir)
897
 
        except errors.PathNotChild:
898
 
            raise errors.BadSubsumeSource(self, other_tree,
899
 
                'Tree is not contained by the other')
900
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
901
 
        if new_root_parent is None:
902
 
            raise errors.BadSubsumeSource(self, other_tree,
903
 
                'Parent directory is not versioned.')
904
 
        # We need to ensure that the result of a fetch will have a
905
 
        # versionedfile for the other_tree root, and only fetching into
906
 
        # RepositoryKnit2 guarantees that.
907
 
        if not self.branch.repository.supports_rich_root():
908
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
909
 
        other_tree.lock_tree_write()
910
 
        try:
911
 
            new_parents = other_tree.get_parent_ids()
912
 
            other_root = other_tree.inventory.root
913
 
            other_root.parent_id = new_root_parent
914
 
            other_root.name = osutils.basename(other_tree_path)
915
 
            self.inventory.add(other_root)
916
 
            add_children(self.inventory, other_root)
917
 
            self._write_inventory(self.inventory)
918
 
            # normally we don't want to fetch whole repositories, but i think
919
 
            # here we really do want to consolidate the whole thing.
920
 
            for parent_id in other_tree.get_parent_ids():
921
 
                self.branch.fetch(other_tree.branch, parent_id)
922
 
                self.add_parent_tree_id(parent_id)
923
 
        finally:
924
 
            other_tree.unlock()
925
 
        other_tree.bzrdir.retire_bzrdir()
926
 
 
927
 
    @needs_tree_write_lock
928
 
    def extract(self, file_id, format=None):
929
 
        """Extract a subtree from this tree.
930
 
        
931
 
        A new branch will be created, relative to the path for this tree.
932
 
        """
933
 
        self.flush()
934
 
        def mkdirs(path):
935
 
            segments = osutils.splitpath(path)
936
 
            transport = self.branch.bzrdir.root_transport
937
 
            for name in segments:
938
 
                transport = transport.clone(name)
939
 
                transport.ensure_base()
940
 
            return transport
941
 
            
942
 
        sub_path = self.id2path(file_id)
943
 
        branch_transport = mkdirs(sub_path)
944
 
        if format is None:
945
 
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
946
 
        branch_transport.ensure_base()
947
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
948
 
        try:
949
 
            repo = branch_bzrdir.find_repository()
950
 
        except errors.NoRepositoryPresent:
951
 
            repo = branch_bzrdir.create_repository()
952
 
            assert repo.supports_rich_root()
953
 
        else:
954
 
            if not repo.supports_rich_root():
955
 
                raise errors.RootNotRich()
956
 
        new_branch = branch_bzrdir.create_branch()
957
 
        new_branch.pull(self.branch)
958
 
        for parent_id in self.get_parent_ids():
959
 
            new_branch.fetch(self.branch, parent_id)
960
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
961
 
        if tree_transport.base != branch_transport.base:
962
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
963
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
964
 
        else:
965
 
            tree_bzrdir = branch_bzrdir
966
 
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
967
 
        wt.set_parent_ids(self.get_parent_ids())
968
 
        my_inv = self.inventory
969
 
        child_inv = Inventory(root_id=None)
970
 
        new_root = my_inv[file_id]
971
 
        my_inv.remove_recursive_id(file_id)
972
 
        new_root.parent_id = None
973
 
        child_inv.add(new_root)
974
 
        self._write_inventory(my_inv)
975
 
        wt._write_inventory(child_inv)
976
 
        return wt
977
 
 
978
 
    def _serialize(self, inventory, out_file):
979
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file)
980
 
 
981
 
    def _deserialize(selt, in_file):
982
 
        return xml5.serializer_v5.read_inventory(in_file)
983
 
 
984
 
    def flush(self):
985
 
        """Write the in memory inventory to disk."""
986
 
        # TODO: Maybe this should only write on dirty ?
987
 
        if self._control_files._lock_mode != 'w':
988
 
            raise errors.NotWriteLocked(self)
989
 
        sio = StringIO()
990
 
        self._serialize(self._inventory, sio)
991
 
        sio.seek(0)
992
 
        self._control_files.put('inventory', sio)
993
 
        self._inventory_is_modified = False
994
 
 
995
 
    def _kind(self, relpath):
996
 
        return osutils.file_kind(self.abspath(relpath))
997
 
 
998
 
    def list_files(self, include_root=False):
999
 
        """Recursively list all files as (path, class, kind, id, entry).
 
192
    def file_class(self, filename):
 
193
        if self.path2id(filename):
 
194
            return 'V'
 
195
        elif self.is_ignored(filename):
 
196
            return 'I'
 
197
        else:
 
198
            return '?'
 
199
 
 
200
 
 
201
    def list_files(self):
 
202
        """Recursively list all files as (path, class, kind, id).
1000
203
 
1001
204
        Lists, but does not descend into unversioned directories.
1002
205
 
1005
208
 
1006
209
        Skips the control directory.
1007
210
        """
1008
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1009
 
        # with it. So callers should be careful to always read_lock the tree.
1010
 
        if not self.is_locked():
1011
 
            raise errors.ObjectNotLocked(self)
1012
 
 
1013
 
        inv = self.inventory
1014
 
        if include_root is True:
1015
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1016
 
        # Convert these into local objects to save lookup times
1017
 
        pathjoin = osutils.pathjoin
1018
 
        file_kind = self._kind
1019
 
 
1020
 
        # transport.base ends in a slash, we want the piece
1021
 
        # between the last two slashes
1022
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1023
 
 
1024
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1025
 
 
1026
 
        # directory file_id, relative path, absolute path, reverse sorted children
1027
 
        children = os.listdir(self.basedir)
1028
 
        children.sort()
1029
 
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1030
 
        # use a deque and popleft to keep them sorted, or if we use a plain
1031
 
        # list and just reverse() them.
1032
 
        children = collections.deque(children)
1033
 
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1034
 
        while stack:
1035
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1036
 
 
1037
 
            while children:
1038
 
                f = children.popleft()
 
211
        inv = self._inventory
 
212
 
 
213
        def descend(from_dir_relpath, from_dir_id, dp):
 
214
            ls = os.listdir(dp)
 
215
            ls.sort()
 
216
            for f in ls:
1039
217
                ## TODO: If we find a subdirectory with its own .bzr
1040
218
                ## directory, then that is a separate tree and we
1041
219
                ## should exclude it.
1042
 
 
1043
 
                # the bzrdir for this tree
1044
 
                if transport_base_dir == f:
 
220
                if bzrlib.BZRDIR == f:
1045
221
                    continue
1046
222
 
1047
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1048
 
                # and 'f' doesn't begin with one, we can do a string op, rather
1049
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
1050
 
                # at the beginning
1051
 
                fp = from_dir_relpath + '/' + f
 
223
                # path within tree
 
224
                fp = appendpath(from_dir_relpath, f)
1052
225
 
1053
226
                # absolute path
1054
 
                fap = from_dir_abspath + '/' + f
 
227
                fap = appendpath(dp, f)
1055
228
                
1056
229
                f_ie = inv.get_child(from_dir_id, f)
1057
230
                if f_ie:
1058
231
                    c = 'V'
1059
 
                elif self.is_ignored(fp[1:]):
 
232
                elif self.is_ignored(fp):
1060
233
                    c = 'I'
1061
234
                else:
1062
 
                    # we may not have found this file, because of a unicode issue
1063
 
                    f_norm, can_access = osutils.normalized_filename(f)
1064
 
                    if f == f_norm or not can_access:
1065
 
                        # No change, so treat this file normally
1066
 
                        c = '?'
1067
 
                    else:
1068
 
                        # this file can be accessed by a normalized path
1069
 
                        # check again if it is versioned
1070
 
                        # these lines are repeated here for performance
1071
 
                        f = f_norm
1072
 
                        fp = from_dir_relpath + '/' + f
1073
 
                        fap = from_dir_abspath + '/' + f
1074
 
                        f_ie = inv.get_child(from_dir_id, f)
1075
 
                        if f_ie:
1076
 
                            c = 'V'
1077
 
                        elif self.is_ignored(fp[1:]):
1078
 
                            c = 'I'
1079
 
                        else:
1080
 
                            c = '?'
 
235
                    c = '?'
1081
236
 
1082
237
                fk = file_kind(fap)
1083
238
 
 
239
                if f_ie:
 
240
                    if f_ie.kind != fk:
 
241
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
242
                                            "now of kind %r"
 
243
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
244
 
1084
245
                # make a last minute entry
1085
246
                if f_ie:
1086
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
247
                    entry = f_ie
1087
248
                else:
1088
 
                    try:
1089
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1090
 
                    except KeyError:
1091
 
                        yield fp[1:], c, fk, None, TreeEntry()
1092
 
                    continue
 
249
                    if fk == 'directory':
 
250
                        entry = TreeDirectory()
 
251
                    elif fk == 'file':
 
252
                        entry = TreeFile()
 
253
                    elif fk == 'symlink':
 
254
                        entry = TreeLink()
 
255
                    else:
 
256
                        entry = TreeEntry()
1093
257
                
 
258
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
 
259
 
1094
260
                if fk != 'directory':
1095
261
                    continue
1096
262
 
1097
 
                # But do this child first
1098
 
                new_children = os.listdir(fap)
1099
 
                new_children.sort()
1100
 
                new_children = collections.deque(new_children)
1101
 
                stack.append((f_ie.file_id, fp, fap, new_children))
1102
 
                # Break out of inner loop,
1103
 
                # so that we start outer loop with child
1104
 
                break
1105
 
            else:
1106
 
                # if we finished all children, pop it off the stack
1107
 
                stack.pop()
1108
 
 
1109
 
    @needs_tree_write_lock
1110
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
1111
 
        """Rename files.
1112
 
 
1113
 
        to_dir must exist in the inventory.
1114
 
 
1115
 
        If to_dir exists and is a directory, the files are moved into
1116
 
        it, keeping their old names.  
1117
 
 
1118
 
        Note that to_dir is only the last component of the new name;
1119
 
        this doesn't change the directory.
1120
 
 
1121
 
        For each entry in from_paths the move mode will be determined
1122
 
        independently.
1123
 
 
1124
 
        The first mode moves the file in the filesystem and updates the
1125
 
        inventory. The second mode only updates the inventory without
1126
 
        touching the file on the filesystem. This is the new mode introduced
1127
 
        in version 0.15.
1128
 
 
1129
 
        move uses the second mode if 'after == True' and the target is not
1130
 
        versioned but present in the working tree.
1131
 
 
1132
 
        move uses the second mode if 'after == False' and the source is
1133
 
        versioned but no longer in the working tree, and the target is not
1134
 
        versioned but present in the working tree.
1135
 
 
1136
 
        move uses the first mode if 'after == False' and the source is
1137
 
        versioned and present in the working tree, and the target is not
1138
 
        versioned and not present in the working tree.
1139
 
 
1140
 
        Everything else results in an error.
1141
 
 
1142
 
        This returns a list of (from_path, to_path) pairs for each
1143
 
        entry that is moved.
1144
 
        """
1145
 
        rename_entries = []
1146
 
        rename_tuples = []
1147
 
 
1148
 
        # check for deprecated use of signature
1149
 
        if to_dir is None:
1150
 
            to_dir = kwargs.get('to_name', None)
1151
 
            if to_dir is None:
1152
 
                raise TypeError('You must supply a target directory')
1153
 
            else:
1154
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1155
 
                                       ' in version 0.13. Use to_dir instead',
1156
 
                                       DeprecationWarning)
1157
 
 
1158
 
        # check destination directory
1159
 
        assert not isinstance(from_paths, basestring)
1160
 
        inv = self.inventory
1161
 
        to_abs = self.abspath(to_dir)
1162
 
        if not isdir(to_abs):
1163
 
            raise errors.BzrMoveFailedError('',to_dir,
1164
 
                errors.NotADirectory(to_abs))
1165
 
        if not self.has_filename(to_dir):
1166
 
            raise errors.BzrMoveFailedError('',to_dir,
1167
 
                errors.NotInWorkingDirectory(to_dir))
1168
 
        to_dir_id = inv.path2id(to_dir)
1169
 
        if to_dir_id is None:
1170
 
            raise errors.BzrMoveFailedError('',to_dir,
1171
 
                errors.NotVersionedError(path=str(to_dir)))
1172
 
 
1173
 
        to_dir_ie = inv[to_dir_id]
1174
 
        if to_dir_ie.kind != 'directory':
1175
 
            raise errors.BzrMoveFailedError('',to_dir,
1176
 
                errors.NotADirectory(to_abs))
1177
 
 
1178
 
        # create rename entries and tuples
1179
 
        for from_rel in from_paths:
1180
 
            from_tail = splitpath(from_rel)[-1]
1181
 
            from_id = inv.path2id(from_rel)
1182
 
            if from_id is None:
1183
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1184
 
                    errors.NotVersionedError(path=str(from_rel)))
1185
 
 
1186
 
            from_entry = inv[from_id]
1187
 
            from_parent_id = from_entry.parent_id
1188
 
            to_rel = pathjoin(to_dir, from_tail)
1189
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1190
 
                                         from_id=from_id,
1191
 
                                         from_tail=from_tail,
1192
 
                                         from_parent_id=from_parent_id,
1193
 
                                         to_rel=to_rel, to_tail=from_tail,
1194
 
                                         to_parent_id=to_dir_id)
1195
 
            rename_entries.append(rename_entry)
1196
 
            rename_tuples.append((from_rel, to_rel))
1197
 
 
1198
 
        # determine which move mode to use. checks also for movability
1199
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1200
 
 
1201
 
        original_modified = self._inventory_is_modified
1202
 
        try:
1203
 
            if len(from_paths):
1204
 
                self._inventory_is_modified = True
1205
 
            self._move(rename_entries)
1206
 
        except:
1207
 
            # restore the inventory on error
1208
 
            self._inventory_is_modified = original_modified
1209
 
            raise
1210
 
        self._write_inventory(inv)
1211
 
        return rename_tuples
1212
 
 
1213
 
    def _determine_mv_mode(self, rename_entries, after=False):
1214
 
        """Determines for each from-to pair if both inventory and working tree
1215
 
        or only the inventory has to be changed.
1216
 
 
1217
 
        Also does basic plausability tests.
1218
 
        """
1219
 
        inv = self.inventory
1220
 
 
1221
 
        for rename_entry in rename_entries:
1222
 
            # store to local variables for easier reference
1223
 
            from_rel = rename_entry.from_rel
1224
 
            from_id = rename_entry.from_id
1225
 
            to_rel = rename_entry.to_rel
1226
 
            to_id = inv.path2id(to_rel)
1227
 
            only_change_inv = False
1228
 
 
1229
 
            # check the inventory for source and destination
1230
 
            if from_id is None:
1231
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1232
 
                    errors.NotVersionedError(path=str(from_rel)))
1233
 
            if to_id is not None:
1234
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1235
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1236
 
 
1237
 
            # try to determine the mode for rename (only change inv or change
1238
 
            # inv and file system)
1239
 
            if after:
1240
 
                if not self.has_filename(to_rel):
1241
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1242
 
                        errors.NoSuchFile(path=str(to_rel),
1243
 
                        extra="New file has not been created yet"))
1244
 
                only_change_inv = True
1245
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1246
 
                only_change_inv = True
1247
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1248
 
                only_change_inv = False
1249
 
            else:
1250
 
                # something is wrong, so lets determine what exactly
1251
 
                if not self.has_filename(from_rel) and \
1252
 
                   not self.has_filename(to_rel):
1253
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1254
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1255
 
                        str(to_rel))))
1256
 
                else:
1257
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
1258
 
                        extra="(Use --after to update the Bazaar id)")
1259
 
            rename_entry.only_change_inv = only_change_inv
1260
 
        return rename_entries
1261
 
 
1262
 
    def _move(self, rename_entries):
1263
 
        """Moves a list of files.
1264
 
 
1265
 
        Depending on the value of the flag 'only_change_inv', the
1266
 
        file will be moved on the file system or not.
1267
 
        """
1268
 
        inv = self.inventory
1269
 
        moved = []
1270
 
 
1271
 
        for entry in rename_entries:
1272
 
            try:
1273
 
                self._move_entry(entry)
1274
 
            except:
1275
 
                self._rollback_move(moved)
1276
 
                raise
1277
 
            moved.append(entry)
1278
 
 
1279
 
    def _rollback_move(self, moved):
1280
 
        """Try to rollback a previous move in case of an filesystem error."""
1281
 
        inv = self.inventory
1282
 
        for entry in moved:
1283
 
            try:
1284
 
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1285
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1286
 
                    entry.from_tail, entry.from_parent_id,
1287
 
                    entry.only_change_inv))
1288
 
            except errors.BzrMoveFailedError, e:
1289
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1290
 
                        " The working tree is in an inconsistent state."
1291
 
                        " Please consider doing a 'bzr revert'."
1292
 
                        " Error message is: %s" % e)
1293
 
 
1294
 
    def _move_entry(self, entry):
1295
 
        inv = self.inventory
1296
 
        from_rel_abs = self.abspath(entry.from_rel)
1297
 
        to_rel_abs = self.abspath(entry.to_rel)
1298
 
        if from_rel_abs == to_rel_abs:
1299
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1300
 
                "Source and target are identical.")
1301
 
 
1302
 
        if not entry.only_change_inv:
1303
 
            try:
1304
 
                osutils.rename(from_rel_abs, to_rel_abs)
1305
 
            except OSError, e:
1306
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1307
 
                    entry.to_rel, e[1])
1308
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1309
 
 
1310
 
    @needs_tree_write_lock
1311
 
    def rename_one(self, from_rel, to_rel, after=False):
1312
 
        """Rename one file.
1313
 
 
1314
 
        This can change the directory or the filename or both.
1315
 
 
1316
 
        rename_one has several 'modes' to work. First, it can rename a physical
1317
 
        file and change the file_id. That is the normal mode. Second, it can
1318
 
        only change the file_id without touching any physical file. This is
1319
 
        the new mode introduced in version 0.15.
1320
 
 
1321
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1322
 
        versioned but present in the working tree.
1323
 
 
1324
 
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1325
 
        versioned but no longer in the working tree, and 'to_rel' is not
1326
 
        versioned but present in the working tree.
1327
 
 
1328
 
        rename_one uses the first mode if 'after == False' and 'from_rel' is
1329
 
        versioned and present in the working tree, and 'to_rel' is not
1330
 
        versioned and not present in the working tree.
1331
 
 
1332
 
        Everything else results in an error.
1333
 
        """
1334
 
        inv = self.inventory
1335
 
        rename_entries = []
1336
 
 
1337
 
        # create rename entries and tuples
1338
 
        from_tail = splitpath(from_rel)[-1]
1339
 
        from_id = inv.path2id(from_rel)
1340
 
        if from_id is None:
1341
 
            raise errors.BzrRenameFailedError(from_rel,to_rel,
1342
 
                errors.NotVersionedError(path=str(from_rel)))
1343
 
        from_entry = inv[from_id]
1344
 
        from_parent_id = from_entry.parent_id
1345
 
        to_dir, to_tail = os.path.split(to_rel)
1346
 
        to_dir_id = inv.path2id(to_dir)
1347
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1348
 
                                     from_id=from_id,
1349
 
                                     from_tail=from_tail,
1350
 
                                     from_parent_id=from_parent_id,
1351
 
                                     to_rel=to_rel, to_tail=to_tail,
1352
 
                                     to_parent_id=to_dir_id)
1353
 
        rename_entries.append(rename_entry)
1354
 
 
1355
 
        # determine which move mode to use. checks also for movability
1356
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1357
 
 
1358
 
        # check if the target changed directory and if the target directory is
1359
 
        # versioned
1360
 
        if to_dir_id is None:
1361
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1362
 
                errors.NotVersionedError(path=str(to_dir)))
1363
 
 
1364
 
        # all checks done. now we can continue with our actual work
1365
 
        mutter('rename_one:\n'
1366
 
               '  from_id   {%s}\n'
1367
 
               '  from_rel: %r\n'
1368
 
               '  to_rel:   %r\n'
1369
 
               '  to_dir    %r\n'
1370
 
               '  to_dir_id {%s}\n',
1371
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1372
 
 
1373
 
        self._move(rename_entries)
1374
 
        self._write_inventory(inv)
1375
 
 
1376
 
    class _RenameEntry(object):
1377
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1378
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1379
 
            self.from_rel = from_rel
1380
 
            self.from_id = from_id
1381
 
            self.from_tail = from_tail
1382
 
            self.from_parent_id = from_parent_id
1383
 
            self.to_rel = to_rel
1384
 
            self.to_tail = to_tail
1385
 
            self.to_parent_id = to_parent_id
1386
 
            self.only_change_inv = only_change_inv
1387
 
 
1388
 
    @needs_read_lock
 
263
                if c != 'V':
 
264
                    # don't descend unversioned directories
 
265
                    continue
 
266
                
 
267
                for ff in descend(fp, f_ie.file_id, fap):
 
268
                    yield ff
 
269
 
 
270
        for f in descend('', inv.root.file_id, self.basedir):
 
271
            yield f
 
272
            
 
273
 
 
274
 
1389
275
    def unknowns(self):
1390
 
        """Return all unknown files.
1391
 
 
1392
 
        These are files in the working directory that are not versioned or
1393
 
        control files or ignored.
1394
 
        """
1395
 
        # force the extras method to be fully executed before returning, to 
1396
 
        # prevent race conditions with the lock
1397
 
        return iter(
1398
 
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1399
 
 
1400
 
    @needs_tree_write_lock
1401
 
    def unversion(self, file_ids):
1402
 
        """Remove the file ids in file_ids from the current versioned set.
1403
 
 
1404
 
        When a file_id is unversioned, all of its children are automatically
1405
 
        unversioned.
1406
 
 
1407
 
        :param file_ids: The file ids to stop versioning.
1408
 
        :raises: NoSuchId if any fileid is not currently versioned.
1409
 
        """
1410
 
        for file_id in file_ids:
1411
 
            file_id = osutils.safe_file_id(file_id)
1412
 
            if self._inventory.has_id(file_id):
1413
 
                self._inventory.remove_recursive_id(file_id)
1414
 
            else:
1415
 
                raise errors.NoSuchId(self, file_id)
1416
 
        if len(file_ids):
1417
 
            # in the future this should just set a dirty bit to wait for the 
1418
 
            # final unlock. However, until all methods of workingtree start
1419
 
            # with the current in -memory inventory rather than triggering 
1420
 
            # a read, it is more complex - we need to teach read_inventory
1421
 
            # to know when to read, and when to not read first... and possibly
1422
 
            # to save first when the in memory one may be corrupted.
1423
 
            # so for now, we just only write it if it is indeed dirty.
1424
 
            # - RBC 20060907
1425
 
            self._write_inventory(self._inventory)
1426
 
    
1427
 
    @deprecated_method(zero_eight)
 
276
        for subp in self.extras():
 
277
            if not self.is_ignored(subp):
 
278
                yield subp
 
279
 
1428
280
    def iter_conflicts(self):
1429
 
        """List all files in the tree that have text or content conflicts.
1430
 
        DEPRECATED.  Use conflicts instead."""
1431
 
        return self._iter_conflicts()
1432
 
 
1433
 
    def _iter_conflicts(self):
1434
281
        conflicted = set()
1435
 
        for info in self.list_files():
1436
 
            path = info[0]
 
282
        for path in (s[0] for s in self.list_files()):
1437
283
            stem = get_conflicted_stem(path)
1438
284
            if stem is None:
1439
285
                continue
1441
287
                conflicted.add(stem)
1442
288
                yield stem
1443
289
 
1444
 
    @needs_write_lock
1445
 
    def pull(self, source, overwrite=False, stop_revision=None,
1446
 
             change_reporter=None):
1447
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1448
 
        source.lock_read()
1449
 
        try:
1450
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
1451
 
            pp.next_phase()
1452
 
            old_revision_info = self.branch.last_revision_info()
1453
 
            basis_tree = self.basis_tree()
1454
 
            count = self.branch.pull(source, overwrite, stop_revision)
1455
 
            new_revision_info = self.branch.last_revision_info()
1456
 
            if new_revision_info != old_revision_info:
1457
 
                pp.next_phase()
1458
 
                repository = self.branch.repository
1459
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1460
 
                basis_tree.lock_read()
1461
 
                try:
1462
 
                    new_basis_tree = self.branch.basis_tree()
1463
 
                    merge.merge_inner(
1464
 
                                self.branch,
1465
 
                                new_basis_tree,
1466
 
                                basis_tree,
1467
 
                                this_tree=self,
1468
 
                                pb=pb,
1469
 
                                change_reporter=change_reporter)
1470
 
                    if (basis_tree.inventory.root is None and
1471
 
                        new_basis_tree.inventory.root is not None):
1472
 
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1473
 
                finally:
1474
 
                    pb.finished()
1475
 
                    basis_tree.unlock()
1476
 
                # TODO - dedup parents list with things merged by pull ?
1477
 
                # reuse the revisiontree we merged against to set the new
1478
 
                # tree data.
1479
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1480
 
                # we have to pull the merge trees out again, because 
1481
 
                # merge_inner has set the ids. - this corner is not yet 
1482
 
                # layered well enough to prevent double handling.
1483
 
                # XXX TODO: Fix the double handling: telling the tree about
1484
 
                # the already known parent data is wasteful.
1485
 
                merges = self.get_parent_ids()[1:]
1486
 
                parent_trees.extend([
1487
 
                    (parent, repository.revision_tree(parent)) for
1488
 
                     parent in merges])
1489
 
                self.set_parent_trees(parent_trees)
1490
 
            return count
1491
 
        finally:
1492
 
            source.unlock()
1493
 
            top_pb.finished()
1494
 
 
1495
 
    @needs_write_lock
1496
 
    def put_file_bytes_non_atomic(self, file_id, bytes):
1497
 
        """See MutableTree.put_file_bytes_non_atomic."""
1498
 
        file_id = osutils.safe_file_id(file_id)
1499
 
        stream = file(self.id2abspath(file_id), 'wb')
1500
 
        try:
1501
 
            stream.write(bytes)
1502
 
        finally:
1503
 
            stream.close()
1504
 
        # TODO: update the hashcache here ?
1505
 
 
1506
290
    def extras(self):
1507
 
        """Yield all unversioned files in this WorkingTree.
 
291
        """Yield all unknown files in this WorkingTree.
1508
292
 
1509
 
        If there are any unversioned directories then only the directory is
1510
 
        returned, not all its children.  But if there are unversioned files
 
293
        If there are any unknown directories then only the directory is
 
294
        returned, not all its children.  But if there are unknown files
1511
295
        under a versioned subdirectory, they are returned.
1512
296
 
1513
297
        Currently returned depth-first, sorted by name within directories.
1514
 
        This is the same order used by 'osutils.walkdirs'.
1515
298
        """
1516
299
        ## TODO: Work from given directory downwards
1517
300
        for path, dir_entry in self.inventory.directories():
1518
 
            # mutter("search for unknowns in %r", path)
 
301
            mutter("search for unknowns in %r" % path)
1519
302
            dirabs = self.abspath(path)
1520
303
            if not isdir(dirabs):
1521
304
                # e.g. directory deleted
1523
306
 
1524
307
            fl = []
1525
308
            for subf in os.listdir(dirabs):
1526
 
                if subf == '.bzr':
1527
 
                    continue
1528
 
                if subf not in dir_entry.children:
1529
 
                    subf_norm, can_access = osutils.normalized_filename(subf)
1530
 
                    if subf_norm != subf and can_access:
1531
 
                        if subf_norm not in dir_entry.children:
1532
 
                            fl.append(subf_norm)
1533
 
                    else:
1534
 
                        fl.append(subf)
 
309
                if (subf != '.bzr'
 
310
                    and (subf not in dir_entry.children)):
 
311
                    fl.append(subf)
1535
312
            
1536
313
            fl.sort()
1537
314
            for subf in fl:
1538
 
                subp = pathjoin(path, subf)
 
315
                subp = appendpath(path, subf)
1539
316
                yield subp
1540
317
 
 
318
 
1541
319
    def ignored_files(self):
1542
320
        """Yield list of PATH, IGNORE_PATTERN"""
1543
321
        for subp in self.extras():
1544
322
            pat = self.is_ignored(subp)
1545
 
            if pat is not None:
 
323
            if pat != None:
1546
324
                yield subp, pat
1547
325
 
 
326
 
1548
327
    def get_ignore_list(self):
1549
328
        """Return list of ignore patterns.
1550
329
 
1551
330
        Cached in the Tree object after the first call.
1552
331
        """
1553
 
        ignoreset = getattr(self, '_ignoreset', None)
1554
 
        if ignoreset is not None:
1555
 
            return ignoreset
 
332
        if hasattr(self, '_ignorelist'):
 
333
            return self._ignorelist
1556
334
 
1557
 
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1558
 
        ignore_globs.update(ignores.get_runtime_ignores())
1559
 
        ignore_globs.update(ignores.get_user_ignores())
 
335
        l = bzrlib.DEFAULT_IGNORE[:]
1560
336
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1561
337
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1562
 
            try:
1563
 
                ignore_globs.update(ignores.parse_ignore_file(f))
1564
 
            finally:
1565
 
                f.close()
1566
 
        self._ignoreset = ignore_globs
1567
 
        return ignore_globs
 
338
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
339
        self._ignorelist = l
 
340
        return l
1568
341
 
1569
 
    def _flush_ignore_list_cache(self):
1570
 
        """Resets the cached ignore list to force a cache rebuild."""
1571
 
        self._ignoreset = None
1572
 
        self._ignoreglobster = None
1573
342
 
1574
343
    def is_ignored(self, filename):
1575
344
        r"""Check whether the filename matches an ignore pattern.
1580
349
        If the file is ignored, returns the pattern which caused it to
1581
350
        be ignored, otherwise None.  So this can simply be used as a
1582
351
        boolean if desired."""
1583
 
        if getattr(self, '_ignoreglobster', None) is None:
1584
 
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1585
 
        return self._ignoreglobster.match(filename)
 
352
 
 
353
        # TODO: Use '**' to match directories, and other extended
 
354
        # globbing stuff from cvs/rsync.
 
355
 
 
356
        # XXX: fnmatch is actually not quite what we want: it's only
 
357
        # approximately the same as real Unix fnmatch, and doesn't
 
358
        # treat dotfiles correctly and allows * to match /.
 
359
        # Eventually it should be replaced with something more
 
360
        # accurate.
 
361
        
 
362
        for pat in self.get_ignore_list():
 
363
            if '/' in pat or '\\' in pat:
 
364
                
 
365
                # as a special case, you can put ./ at the start of a
 
366
                # pattern; this is good to match in the top-level
 
367
                # only;
 
368
                
 
369
                if (pat[:2] == './') or (pat[:2] == '.\\'):
 
370
                    newpat = pat[2:]
 
371
                else:
 
372
                    newpat = pat
 
373
                if fnmatch.fnmatchcase(filename, newpat):
 
374
                    return pat
 
375
            else:
 
376
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
377
                    return pat
 
378
        else:
 
379
            return None
1586
380
 
1587
381
    def kind(self, file_id):
1588
382
        return file_kind(self.id2abspath(file_id))
1589
383
 
1590
 
    def _comparison_data(self, entry, path):
1591
 
        abspath = self.abspath(path)
1592
 
        try:
1593
 
            stat_value = os.lstat(abspath)
1594
 
        except OSError, e:
1595
 
            if getattr(e, 'errno', None) == errno.ENOENT:
1596
 
                stat_value = None
1597
 
                kind = None
1598
 
                executable = False
1599
 
            else:
1600
 
                raise
1601
 
        else:
1602
 
            mode = stat_value.st_mode
1603
 
            kind = osutils.file_kind_from_stat_mode(mode)
1604
 
            if not supports_executable():
1605
 
                executable = entry is not None and entry.executable
1606
 
            else:
1607
 
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1608
 
        return kind, executable, stat_value
1609
 
 
1610
 
    def _file_size(self, entry, stat_value):
1611
 
        return stat_value.st_size
1612
 
 
1613
 
    def last_revision(self):
1614
 
        """Return the last revision of the branch for this tree.
1615
 
 
1616
 
        This format tree does not support a separate marker for last-revision
1617
 
        compared to the branch.
1618
 
 
1619
 
        See MutableTree.last_revision
1620
 
        """
1621
 
        return self._last_revision()
1622
 
 
1623
 
    @needs_read_lock
1624
 
    def _last_revision(self):
1625
 
        """helper for get_parent_ids."""
1626
 
        return self.branch.last_revision()
1627
 
 
1628
 
    def is_locked(self):
1629
 
        return self._control_files.is_locked()
1630
 
 
1631
 
    def _must_be_locked(self):
1632
 
        if not self.is_locked():
1633
 
            raise errors.ObjectNotLocked(self)
1634
 
 
1635
 
    def lock_read(self):
1636
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1637
 
        if not self.is_locked():
1638
 
            self._reset_data()
1639
 
        self.branch.lock_read()
1640
 
        try:
1641
 
            return self._control_files.lock_read()
1642
 
        except:
1643
 
            self.branch.unlock()
1644
 
            raise
1645
 
 
1646
 
    def lock_tree_write(self):
1647
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1648
 
        if not self.is_locked():
1649
 
            self._reset_data()
1650
 
        self.branch.lock_read()
1651
 
        try:
1652
 
            return self._control_files.lock_write()
1653
 
        except:
1654
 
            self.branch.unlock()
1655
 
            raise
1656
 
 
1657
 
    def lock_write(self):
1658
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1659
 
        if not self.is_locked():
1660
 
            self._reset_data()
1661
 
        self.branch.lock_write()
1662
 
        try:
1663
 
            return self._control_files.lock_write()
1664
 
        except:
1665
 
            self.branch.unlock()
1666
 
            raise
1667
 
 
1668
 
    def get_physical_lock_status(self):
1669
 
        return self._control_files.get_physical_lock_status()
1670
 
 
1671
 
    def _basis_inventory_name(self):
1672
 
        return 'basis-inventory-cache'
1673
 
 
1674
 
    def _reset_data(self):
1675
 
        """Reset transient data that cannot be revalidated."""
1676
 
        self._inventory_is_modified = False
1677
 
        result = self._deserialize(self._control_files.get('inventory'))
1678
 
        self._set_inventory(result, dirty=False)
1679
 
 
1680
 
    @needs_tree_write_lock
1681
 
    def set_last_revision(self, new_revision):
1682
 
        """Change the last revision in the working tree."""
1683
 
        new_revision = osutils.safe_revision_id(new_revision)
1684
 
        if self._change_last_revision(new_revision):
1685
 
            self._cache_basis_inventory(new_revision)
1686
 
 
1687
 
    def _change_last_revision(self, new_revision):
1688
 
        """Template method part of set_last_revision to perform the change.
1689
 
        
1690
 
        This is used to allow WorkingTree3 instances to not affect branch
1691
 
        when their last revision is set.
1692
 
        """
1693
 
        if _mod_revision.is_null(new_revision):
1694
 
            self.branch.set_revision_history([])
1695
 
            return False
1696
 
        try:
1697
 
            self.branch.generate_revision_history(new_revision)
1698
 
        except errors.NoSuchRevision:
1699
 
            # not present in the repo - dont try to set it deeper than the tip
1700
 
            self.branch.set_revision_history([new_revision])
1701
 
        return True
1702
 
 
1703
 
    def _write_basis_inventory(self, xml):
1704
 
        """Write the basis inventory XML to the basis-inventory file"""
1705
 
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1706
 
        path = self._basis_inventory_name()
1707
 
        sio = StringIO(xml)
1708
 
        self._control_files.put(path, sio)
1709
 
 
1710
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1711
 
        """Create the text that will be saved in basis-inventory"""
1712
 
        # TODO: jam 20070209 This should be redundant, as the revision_id
1713
 
        #       as all callers should have already converted the revision_id to
1714
 
        #       utf8
1715
 
        inventory.revision_id = osutils.safe_revision_id(revision_id)
1716
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1717
 
 
1718
 
    def _cache_basis_inventory(self, new_revision):
1719
 
        """Cache new_revision as the basis inventory."""
1720
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1721
 
        # as commit already has that ready-to-use [while the format is the
1722
 
        # same, that is].
1723
 
        try:
1724
 
            # this double handles the inventory - unpack and repack - 
1725
 
            # but is easier to understand. We can/should put a conditional
1726
 
            # in here based on whether the inventory is in the latest format
1727
 
            # - perhaps we should repack all inventories on a repository
1728
 
            # upgrade ?
1729
 
            # the fast path is to copy the raw xml from the repository. If the
1730
 
            # xml contains 'revision_id="', then we assume the right 
1731
 
            # revision_id is set. We must check for this full string, because a
1732
 
            # root node id can legitimately look like 'revision_id' but cannot
1733
 
            # contain a '"'.
1734
 
            xml = self.branch.repository.get_inventory_xml(new_revision)
1735
 
            firstline = xml.split('\n', 1)[0]
1736
 
            if (not 'revision_id="' in firstline or 
1737
 
                'format="7"' not in firstline):
1738
 
                inv = self.branch.repository.deserialise_inventory(
1739
 
                    new_revision, xml)
1740
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1741
 
            self._write_basis_inventory(xml)
1742
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1743
 
            pass
1744
 
 
1745
 
    def read_basis_inventory(self):
1746
 
        """Read the cached basis inventory."""
1747
 
        path = self._basis_inventory_name()
1748
 
        return self._control_files.get(path).read()
1749
 
        
1750
 
    @needs_read_lock
1751
 
    def read_working_inventory(self):
1752
 
        """Read the working inventory.
1753
 
        
1754
 
        :raises errors.InventoryModified: read_working_inventory will fail
1755
 
            when the current in memory inventory has been modified.
1756
 
        """
1757
 
        # conceptually this should be an implementation detail of the tree. 
1758
 
        # XXX: Deprecate this.
1759
 
        # ElementTree does its own conversion from UTF-8, so open in
1760
 
        # binary.
1761
 
        if self._inventory_is_modified:
1762
 
            raise errors.InventoryModified(self)
1763
 
        result = self._deserialize(self._control_files.get('inventory'))
1764
 
        self._set_inventory(result, dirty=False)
1765
 
        return result
1766
 
 
1767
 
    @needs_tree_write_lock
1768
 
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1769
 
        force=False):
1770
 
        """Remove nominated files from the working inventory.
1771
 
 
1772
 
        :files: File paths relative to the basedir.
1773
 
        :keep_files: If true, the files will also be kept.
1774
 
        :force: Delete files and directories, even if they are changed and
1775
 
            even if the directories are not empty.
1776
 
        """
1777
 
        ## TODO: Normalize names
1778
 
 
1779
 
        if isinstance(files, basestring):
1780
 
            files = [files]
1781
 
 
1782
 
        inv_delta = []
1783
 
 
1784
 
        new_files=set()
1785
 
        unknown_files_in_directory=set()
1786
 
 
1787
 
        def recurse_directory_to_add_files(directory):
1788
 
            # recurse directory and add all files
1789
 
            # so we can check if they have changed.
1790
 
            for parent_info, file_infos in\
1791
 
                osutils.walkdirs(self.abspath(directory),
1792
 
                    directory):
1793
 
                for relpath, basename, kind, lstat, abspath in file_infos:
1794
 
                    if kind == 'file':
1795
 
                        if self.path2id(relpath): #is it versioned?
1796
 
                            new_files.add(relpath)
1797
 
                        else:
1798
 
                            unknown_files_in_directory.add(
1799
 
                                (relpath, None, kind))
1800
 
 
1801
 
        for filename in files:
1802
 
            # Get file name into canonical form.
1803
 
            abspath = self.abspath(filename)
1804
 
            filename = self.relpath(abspath)
1805
 
            if len(filename) > 0:
1806
 
                new_files.add(filename)
1807
 
                if osutils.isdir(abspath):
1808
 
                    recurse_directory_to_add_files(filename)
1809
 
        files = [f for f in new_files]
1810
 
 
1811
 
        if len(files) == 0:
1812
 
            return # nothing to do
1813
 
 
1814
 
        # Sort needed to first handle directory content before the directory
1815
 
        files.sort(reverse=True)
1816
 
        if not keep_files and not force:
1817
 
            has_changed_files = len(unknown_files_in_directory) > 0
1818
 
            if not has_changed_files:
1819
 
                for (file_id, path, content_change, versioned, parent_id, name,
1820
 
                     kind, executable) in self._iter_changes(self.basis_tree(),
1821
 
                         include_unchanged=True, require_versioned=False,
1822
 
                         want_unversioned=True, specific_files=files):
1823
 
                    # check if it's unknown OR changed but not deleted:
1824
 
                    if (versioned == (False, False)
1825
 
                        or (content_change and kind[1] != None)):
1826
 
                        has_changed_files = True
1827
 
                        break
1828
 
 
1829
 
            if has_changed_files:
1830
 
                # make delta to show ALL applicable changes in error message.
1831
 
                tree_delta = self.changes_from(self.basis_tree(),
1832
 
                    specific_files=files)
1833
 
                for unknown_file in unknown_files_in_directory:
1834
 
                    tree_delta.unversioned.extend((unknown_file,))
1835
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
1836
 
 
1837
 
        # do this before any modifications
1838
 
        for f in files:
1839
 
            fid = self.path2id(f)
1840
 
            message=None
1841
 
            if not fid:
1842
 
                message="%s is not versioned." % (f,)
1843
 
            else:
1844
 
                if verbose:
1845
 
                    # having removed it, it must be either ignored or unknown
1846
 
                    if self.is_ignored(f):
1847
 
                        new_status = 'I'
1848
 
                    else:
1849
 
                        new_status = '?'
1850
 
                    textui.show_status(new_status, self.kind(fid), f,
1851
 
                                       to_file=to_file)
1852
 
                # unversion file
1853
 
                inv_delta.append((f, None, fid, None))
1854
 
                message="removed %s" % (f,)
1855
 
 
1856
 
            if not keep_files:
1857
 
                abs_path = self.abspath(f)
1858
 
                if osutils.lexists(abs_path):
1859
 
                    if (osutils.isdir(abs_path) and
1860
 
                        len(os.listdir(abs_path)) > 0):
1861
 
                        message="%s is not empty directory "\
1862
 
                            "and won't be deleted." % (f,)
1863
 
                    else:
1864
 
                        osutils.delete_any(abs_path)
1865
 
                        message="deleted %s" % (f,)
1866
 
                elif message is not None:
1867
 
                    # only care if we haven't done anything yet.
1868
 
                    message="%s does not exist." % (f,)
1869
 
 
1870
 
            # print only one message (if any) per file.
1871
 
            if message is not None:
1872
 
                note(message)
1873
 
        self.apply_inventory_delta(inv_delta)
1874
 
 
1875
 
    @needs_tree_write_lock
1876
 
    def revert(self, filenames, old_tree=None, backups=True, 
1877
 
               pb=DummyProgress(), report_changes=False):
1878
 
        from bzrlib.conflicts import resolve
1879
 
        if old_tree is None:
1880
 
            old_tree = self.basis_tree()
1881
 
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1882
 
                                     report_changes)
1883
 
        if not len(filenames):
1884
 
            self.set_parent_ids(self.get_parent_ids()[:1])
1885
 
            resolve(self)
1886
 
        else:
1887
 
            resolve(self, filenames, ignore_misses=True)
1888
 
        return conflicts
1889
 
 
1890
 
    def revision_tree(self, revision_id):
1891
 
        """See Tree.revision_tree.
1892
 
 
1893
 
        WorkingTree can supply revision_trees for the basis revision only
1894
 
        because there is only one cached inventory in the bzr directory.
1895
 
        """
1896
 
        if revision_id == self.last_revision():
1897
 
            try:
1898
 
                xml = self.read_basis_inventory()
1899
 
            except errors.NoSuchFile:
1900
 
                pass
1901
 
            else:
1902
 
                try:
1903
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
1904
 
                    # dont use the repository revision_tree api because we want
1905
 
                    # to supply the inventory.
1906
 
                    if inv.revision_id == revision_id:
1907
 
                        return revisiontree.RevisionTree(self.branch.repository,
1908
 
                            inv, revision_id)
1909
 
                except errors.BadInventoryFormat:
1910
 
                    pass
1911
 
        # raise if there was no inventory, or if we read the wrong inventory.
1912
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
1913
 
 
1914
 
    # XXX: This method should be deprecated in favour of taking in a proper
1915
 
    # new Inventory object.
1916
 
    @needs_tree_write_lock
1917
 
    def set_inventory(self, new_inventory_list):
1918
 
        from bzrlib.inventory import (Inventory,
1919
 
                                      InventoryDirectory,
1920
 
                                      InventoryEntry,
1921
 
                                      InventoryFile,
1922
 
                                      InventoryLink)
1923
 
        inv = Inventory(self.get_root_id())
1924
 
        for path, file_id, parent, kind in new_inventory_list:
1925
 
            name = os.path.basename(path)
1926
 
            if name == "":
1927
 
                continue
1928
 
            # fixme, there should be a factory function inv,add_?? 
1929
 
            if kind == 'directory':
1930
 
                inv.add(InventoryDirectory(file_id, name, parent))
1931
 
            elif kind == 'file':
1932
 
                inv.add(InventoryFile(file_id, name, parent))
1933
 
            elif kind == 'symlink':
1934
 
                inv.add(InventoryLink(file_id, name, parent))
1935
 
            else:
1936
 
                raise errors.BzrError("unknown kind %r" % kind)
1937
 
        self._write_inventory(inv)
1938
 
 
1939
 
    @needs_tree_write_lock
1940
 
    def set_root_id(self, file_id):
1941
 
        """Set the root id for this tree."""
1942
 
        # for compatability 
1943
 
        if file_id is None:
1944
 
            symbol_versioning.warn(symbol_versioning.zero_twelve
1945
 
                % 'WorkingTree.set_root_id with fileid=None',
1946
 
                DeprecationWarning,
1947
 
                stacklevel=3)
1948
 
            file_id = ROOT_ID
1949
 
        else:
1950
 
            file_id = osutils.safe_file_id(file_id)
1951
 
        self._set_root_id(file_id)
1952
 
 
1953
 
    def _set_root_id(self, file_id):
1954
 
        """Set the root id for this tree, in a format specific manner.
1955
 
 
1956
 
        :param file_id: The file id to assign to the root. It must not be 
1957
 
            present in the current inventory or an error will occur. It must
1958
 
            not be None, but rather a valid file id.
1959
 
        """
1960
 
        inv = self._inventory
1961
 
        orig_root_id = inv.root.file_id
1962
 
        # TODO: it might be nice to exit early if there was nothing
1963
 
        # to do, saving us from trigger a sync on unlock.
1964
 
        self._inventory_is_modified = True
1965
 
        # we preserve the root inventory entry object, but
1966
 
        # unlinkit from the byid index
1967
 
        del inv._byid[inv.root.file_id]
1968
 
        inv.root.file_id = file_id
1969
 
        # and link it into the index with the new changed id.
1970
 
        inv._byid[inv.root.file_id] = inv.root
1971
 
        # and finally update all children to reference the new id.
1972
 
        # XXX: this should be safe to just look at the root.children
1973
 
        # list, not the WHOLE INVENTORY.
1974
 
        for fid in inv:
1975
 
            entry = inv[fid]
1976
 
            if entry.parent_id == orig_root_id:
1977
 
                entry.parent_id = inv.root.file_id
1978
 
 
1979
 
    def unlock(self):
1980
 
        """See Branch.unlock.
1981
 
        
1982
 
        WorkingTree locking just uses the Branch locking facilities.
1983
 
        This is current because all working trees have an embedded branch
1984
 
        within them. IF in the future, we were to make branch data shareable
1985
 
        between multiple working trees, i.e. via shared storage, then we 
1986
 
        would probably want to lock both the local tree, and the branch.
1987
 
        """
1988
 
        raise NotImplementedError(self.unlock)
1989
 
 
1990
 
    def update(self, change_reporter=None):
1991
 
        """Update a working tree along its branch.
1992
 
 
1993
 
        This will update the branch if its bound too, which means we have
1994
 
        multiple trees involved:
1995
 
 
1996
 
        - The new basis tree of the master.
1997
 
        - The old basis tree of the branch.
1998
 
        - The old basis tree of the working tree.
1999
 
        - The current working tree state.
2000
 
 
2001
 
        Pathologically, all three may be different, and non-ancestors of each
2002
 
        other.  Conceptually we want to:
2003
 
 
2004
 
        - Preserve the wt.basis->wt.state changes
2005
 
        - Transform the wt.basis to the new master basis.
2006
 
        - Apply a merge of the old branch basis to get any 'local' changes from
2007
 
          it into the tree.
2008
 
        - Restore the wt.basis->wt.state changes.
2009
 
 
2010
 
        There isn't a single operation at the moment to do that, so we:
2011
 
        - Merge current state -> basis tree of the master w.r.t. the old tree
2012
 
          basis.
2013
 
        - Do a 'normal' merge of the old branch basis if it is relevant.
2014
 
        """
2015
 
        if self.branch.get_master_branch() is not None:
2016
 
            self.lock_write()
2017
 
            update_branch = True
2018
 
        else:
2019
 
            self.lock_tree_write()
2020
 
            update_branch = False
2021
 
        try:
2022
 
            if update_branch:
2023
 
                old_tip = self.branch.update()
2024
 
            else:
2025
 
                old_tip = None
2026
 
            return self._update_tree(old_tip, change_reporter)
2027
 
        finally:
2028
 
            self.unlock()
2029
 
 
2030
 
    @needs_tree_write_lock
2031
 
    def _update_tree(self, old_tip=None, change_reporter=None):
2032
 
        """Update a tree to the master branch.
2033
 
 
2034
 
        :param old_tip: if supplied, the previous tip revision the branch,
2035
 
            before it was changed to the master branch's tip.
2036
 
        """
2037
 
        # here if old_tip is not None, it is the old tip of the branch before
2038
 
        # it was updated from the master branch. This should become a pending
2039
 
        # merge in the working tree to preserve the user existing work.  we
2040
 
        # cant set that until we update the working trees last revision to be
2041
 
        # one from the new branch, because it will just get absorbed by the
2042
 
        # parent de-duplication logic.
2043
 
        # 
2044
 
        # We MUST save it even if an error occurs, because otherwise the users
2045
 
        # local work is unreferenced and will appear to have been lost.
2046
 
        # 
2047
 
        result = 0
2048
 
        try:
2049
 
            last_rev = self.get_parent_ids()[0]
2050
 
        except IndexError:
2051
 
            last_rev = _mod_revision.NULL_REVISION
2052
 
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2053
 
            # merge tree state up to new branch tip.
2054
 
            basis = self.basis_tree()
2055
 
            basis.lock_read()
2056
 
            try:
2057
 
                to_tree = self.branch.basis_tree()
2058
 
                if basis.inventory.root is None:
2059
 
                    self.set_root_id(to_tree.inventory.root.file_id)
2060
 
                    self.flush()
2061
 
                result += merge.merge_inner(
2062
 
                                      self.branch,
2063
 
                                      to_tree,
2064
 
                                      basis,
2065
 
                                      this_tree=self,
2066
 
                                      change_reporter=change_reporter)
2067
 
            finally:
2068
 
                basis.unlock()
2069
 
            # TODO - dedup parents list with things merged by pull ?
2070
 
            # reuse the tree we've updated to to set the basis:
2071
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
2072
 
            merges = self.get_parent_ids()[1:]
2073
 
            # Ideally we ask the tree for the trees here, that way the working
2074
 
            # tree can decide whether to give us teh entire tree or give us a
2075
 
            # lazy initialised tree. dirstate for instance will have the trees
2076
 
            # in ram already, whereas a last-revision + basis-inventory tree
2077
 
            # will not, but also does not need them when setting parents.
2078
 
            for parent in merges:
2079
 
                parent_trees.append(
2080
 
                    (parent, self.branch.repository.revision_tree(parent)))
2081
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2082
 
                parent_trees.append(
2083
 
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2084
 
            self.set_parent_trees(parent_trees)
2085
 
            last_rev = parent_trees[0][0]
2086
 
        else:
2087
 
            # the working tree had the same last-revision as the master
2088
 
            # branch did. We may still have pivot local work from the local
2089
 
            # branch into old_tip:
2090
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2091
 
                self.add_parent_tree_id(old_tip)
2092
 
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
2093
 
            and old_tip != last_rev):
2094
 
            # our last revision was not the prior branch last revision
2095
 
            # and we have converted that last revision to a pending merge.
2096
 
            # base is somewhere between the branch tip now
2097
 
            # and the now pending merge
2098
 
 
2099
 
            # Since we just modified the working tree and inventory, flush out
2100
 
            # the current state, before we modify it again.
2101
 
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2102
 
            #       requires it only because TreeTransform directly munges the
2103
 
            #       inventory and calls tree._write_inventory(). Ultimately we
2104
 
            #       should be able to remove this extra flush.
2105
 
            self.flush()
2106
 
            graph = self.branch.repository.get_graph()
2107
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2108
 
                                                old_tip)
2109
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2110
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2111
 
            result += merge.merge_inner(
2112
 
                                  self.branch,
2113
 
                                  other_tree,
2114
 
                                  base_tree,
2115
 
                                  this_tree=self,
2116
 
                                  change_reporter=change_reporter)
2117
 
        return result
2118
 
 
2119
 
    def _write_hashcache_if_dirty(self):
2120
 
        """Write out the hashcache if it is dirty."""
2121
 
        if self._hashcache.needs_write:
2122
 
            try:
2123
 
                self._hashcache.write()
2124
 
            except OSError, e:
2125
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2126
 
                    raise
2127
 
                # TODO: jam 20061219 Should this be a warning? A single line
2128
 
                #       warning might be sufficient to let the user know what
2129
 
                #       is going on.
2130
 
                mutter('Could not write hashcache for %s\nError: %s',
2131
 
                       self._hashcache.cache_file_name(), e)
2132
 
 
2133
 
    @needs_tree_write_lock
2134
 
    def _write_inventory(self, inv):
2135
 
        """Write inventory as the current inventory."""
2136
 
        self._set_inventory(inv, dirty=True)
2137
 
        self.flush()
2138
 
 
2139
 
    def set_conflicts(self, arg):
2140
 
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2141
 
 
2142
 
    def add_conflicts(self, arg):
2143
 
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2144
 
 
2145
 
    @needs_read_lock
2146
 
    def conflicts(self):
2147
 
        conflicts = _mod_conflicts.ConflictList()
2148
 
        for conflicted in self._iter_conflicts():
2149
 
            text = True
2150
 
            try:
2151
 
                if file_kind(self.abspath(conflicted)) != "file":
2152
 
                    text = False
2153
 
            except errors.NoSuchFile:
2154
 
                text = False
2155
 
            if text is True:
2156
 
                for suffix in ('.THIS', '.OTHER'):
2157
 
                    try:
2158
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2159
 
                        if kind != "file":
2160
 
                            text = False
2161
 
                    except errors.NoSuchFile:
2162
 
                        text = False
2163
 
                    if text == False:
2164
 
                        break
2165
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2166
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2167
 
                             path=conflicted,
2168
 
                             file_id=self.path2id(conflicted)))
2169
 
        return conflicts
2170
 
 
2171
 
    def walkdirs(self, prefix=""):
2172
 
        """Walk the directories of this tree.
2173
 
 
2174
 
        returns a generator which yields items in the form:
2175
 
                ((curren_directory_path, fileid),
2176
 
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2177
 
                   file1_kind), ... ])
2178
 
 
2179
 
        This API returns a generator, which is only valid during the current
2180
 
        tree transaction - within a single lock_read or lock_write duration.
2181
 
 
2182
 
        If the tree is not locked, it may cause an error to be raised,
2183
 
        depending on the tree implementation.
2184
 
        """
2185
 
        disk_top = self.abspath(prefix)
2186
 
        if disk_top.endswith('/'):
2187
 
            disk_top = disk_top[:-1]
2188
 
        top_strip_len = len(disk_top) + 1
2189
 
        inventory_iterator = self._walkdirs(prefix)
2190
 
        disk_iterator = osutils.walkdirs(disk_top, prefix)
2191
 
        try:
2192
 
            current_disk = disk_iterator.next()
2193
 
            disk_finished = False
2194
 
        except OSError, e:
2195
 
            if not (e.errno == errno.ENOENT or
2196
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2197
 
                raise
2198
 
            current_disk = None
2199
 
            disk_finished = True
2200
 
        try:
2201
 
            current_inv = inventory_iterator.next()
2202
 
            inv_finished = False
2203
 
        except StopIteration:
2204
 
            current_inv = None
2205
 
            inv_finished = True
2206
 
        while not inv_finished or not disk_finished:
2207
 
            if not disk_finished:
2208
 
                # strip out .bzr dirs
2209
 
                if current_disk[0][1][top_strip_len:] == '':
2210
 
                    # osutils.walkdirs can be made nicer - 
2211
 
                    # yield the path-from-prefix rather than the pathjoined
2212
 
                    # value.
2213
 
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2214
 
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2215
 
                        # we dont yield the contents of, or, .bzr itself.
2216
 
                        del current_disk[1][bzrdir_loc]
2217
 
            if inv_finished:
2218
 
                # everything is unknown
2219
 
                direction = 1
2220
 
            elif disk_finished:
2221
 
                # everything is missing
2222
 
                direction = -1
2223
 
            else:
2224
 
                direction = cmp(current_inv[0][0], current_disk[0][0])
2225
 
            if direction > 0:
2226
 
                # disk is before inventory - unknown
2227
 
                dirblock = [(relpath, basename, kind, stat, None, None) for
2228
 
                    relpath, basename, kind, stat, top_path in current_disk[1]]
2229
 
                yield (current_disk[0][0], None), dirblock
2230
 
                try:
2231
 
                    current_disk = disk_iterator.next()
2232
 
                except StopIteration:
2233
 
                    disk_finished = True
2234
 
            elif direction < 0:
2235
 
                # inventory is before disk - missing.
2236
 
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2237
 
                    for relpath, basename, dkind, stat, fileid, kind in 
2238
 
                    current_inv[1]]
2239
 
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2240
 
                try:
2241
 
                    current_inv = inventory_iterator.next()
2242
 
                except StopIteration:
2243
 
                    inv_finished = True
2244
 
            else:
2245
 
                # versioned present directory
2246
 
                # merge the inventory and disk data together
2247
 
                dirblock = []
2248
 
                for relpath, subiterator in itertools.groupby(sorted(
2249
 
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2250
 
                    path_elements = list(subiterator)
2251
 
                    if len(path_elements) == 2:
2252
 
                        inv_row, disk_row = path_elements
2253
 
                        # versioned, present file
2254
 
                        dirblock.append((inv_row[0],
2255
 
                            inv_row[1], disk_row[2],
2256
 
                            disk_row[3], inv_row[4],
2257
 
                            inv_row[5]))
2258
 
                    elif len(path_elements[0]) == 5:
2259
 
                        # unknown disk file
2260
 
                        dirblock.append((path_elements[0][0],
2261
 
                            path_elements[0][1], path_elements[0][2],
2262
 
                            path_elements[0][3], None, None))
2263
 
                    elif len(path_elements[0]) == 6:
2264
 
                        # versioned, absent file.
2265
 
                        dirblock.append((path_elements[0][0],
2266
 
                            path_elements[0][1], 'unknown', None,
2267
 
                            path_elements[0][4], path_elements[0][5]))
2268
 
                    else:
2269
 
                        raise NotImplementedError('unreachable code')
2270
 
                yield current_inv[0], dirblock
2271
 
                try:
2272
 
                    current_inv = inventory_iterator.next()
2273
 
                except StopIteration:
2274
 
                    inv_finished = True
2275
 
                try:
2276
 
                    current_disk = disk_iterator.next()
2277
 
                except StopIteration:
2278
 
                    disk_finished = True
2279
 
 
2280
 
    def _walkdirs(self, prefix=""):
2281
 
        """Walk the directories of this tree.
2282
 
 
2283
 
           :prefix: is used as the directrory to start with.
2284
 
           returns a generator which yields items in the form:
2285
 
                ((curren_directory_path, fileid),
2286
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2287
 
                   file1_kind), ... ])
2288
 
        """
2289
 
        _directory = 'directory'
2290
 
        # get the root in the inventory
2291
 
        inv = self.inventory
2292
 
        top_id = inv.path2id(prefix)
2293
 
        if top_id is None:
2294
 
            pending = []
2295
 
        else:
2296
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2297
 
        while pending:
2298
 
            dirblock = []
2299
 
            currentdir = pending.pop()
2300
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2301
 
            top_id = currentdir[4]
2302
 
            if currentdir[0]:
2303
 
                relroot = currentdir[0] + '/'
2304
 
            else:
2305
 
                relroot = ""
2306
 
            # FIXME: stash the node in pending
2307
 
            entry = inv[top_id]
2308
 
            for name, child in entry.sorted_children():
2309
 
                dirblock.append((relroot + name, name, child.kind, None,
2310
 
                    child.file_id, child.kind
2311
 
                    ))
2312
 
            yield (currentdir[0], entry.file_id), dirblock
2313
 
            # push the user specified dirs from dirblock
2314
 
            for dir in reversed(dirblock):
2315
 
                if dir[2] == _directory:
2316
 
                    pending.append(dir)
2317
 
 
2318
 
    @needs_tree_write_lock
2319
 
    def auto_resolve(self):
2320
 
        """Automatically resolve text conflicts according to contents.
2321
 
 
2322
 
        Only text conflicts are auto_resolvable. Files with no conflict markers
2323
 
        are considered 'resolved', because bzr always puts conflict markers
2324
 
        into files that have text conflicts.  The corresponding .THIS .BASE and
2325
 
        .OTHER files are deleted, as per 'resolve'.
2326
 
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2327
 
        """
2328
 
        un_resolved = _mod_conflicts.ConflictList()
2329
 
        resolved = _mod_conflicts.ConflictList()
2330
 
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
2331
 
        for conflict in self.conflicts():
2332
 
            if (conflict.typestring != 'text conflict' or
2333
 
                self.kind(conflict.file_id) != 'file'):
2334
 
                un_resolved.append(conflict)
2335
 
                continue
2336
 
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
2337
 
            try:
2338
 
                for line in my_file:
2339
 
                    if conflict_re.search(line):
2340
 
                        un_resolved.append(conflict)
2341
 
                        break
2342
 
                else:
2343
 
                    resolved.append(conflict)
2344
 
            finally:
2345
 
                my_file.close()
2346
 
        resolved.remove_files(self)
2347
 
        self.set_conflicts(un_resolved)
2348
 
        return un_resolved, resolved
2349
 
 
2350
 
    def _validate(self):
2351
 
        """Validate internal structures.
2352
 
 
2353
 
        This is meant mostly for the test suite. To give it a chance to detect
2354
 
        corruption after actions have occurred. The default implementation is a
2355
 
        just a no-op.
2356
 
 
2357
 
        :return: None. An exception should be raised if there is an error.
2358
 
        """
2359
 
        return
2360
 
 
2361
 
 
2362
 
class WorkingTree2(WorkingTree):
2363
 
    """This is the Format 2 working tree.
2364
 
 
2365
 
    This was the first weave based working tree. 
2366
 
     - uses os locks for locking.
2367
 
     - uses the branch last-revision.
2368
 
    """
2369
 
 
2370
 
    def __init__(self, *args, **kwargs):
2371
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2372
 
        # WorkingTree2 has more of a constraint that self._inventory must
2373
 
        # exist. Because this is an older format, we don't mind the overhead
2374
 
        # caused by the extra computation here.
2375
 
 
2376
 
        # Newer WorkingTree's should only have self._inventory set when they
2377
 
        # have a read lock.
2378
 
        if self._inventory is None:
2379
 
            self.read_working_inventory()
2380
 
 
2381
 
    def lock_tree_write(self):
2382
 
        """See WorkingTree.lock_tree_write().
2383
 
 
2384
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2385
 
        so lock_tree_write() degrades to lock_write().
2386
 
        """
2387
 
        self.branch.lock_write()
2388
 
        try:
2389
 
            return self._control_files.lock_write()
2390
 
        except:
2391
 
            self.branch.unlock()
2392
 
            raise
2393
 
 
2394
 
    def unlock(self):
2395
 
        # we share control files:
2396
 
        if self._control_files._lock_count == 3:
2397
 
            # _inventory_is_modified is always False during a read lock.
2398
 
            if self._inventory_is_modified:
2399
 
                self.flush()
2400
 
            self._write_hashcache_if_dirty()
2401
 
                    
2402
 
        # reverse order of locking.
2403
 
        try:
2404
 
            return self._control_files.unlock()
2405
 
        finally:
2406
 
            self.branch.unlock()
2407
 
 
2408
 
 
2409
 
class WorkingTree3(WorkingTree):
2410
 
    """This is the Format 3 working tree.
2411
 
 
2412
 
    This differs from the base WorkingTree by:
2413
 
     - having its own file lock
2414
 
     - having its own last-revision property.
2415
 
 
2416
 
    This is new in bzr 0.8
2417
 
    """
2418
 
 
2419
 
    @needs_read_lock
2420
 
    def _last_revision(self):
2421
 
        """See Mutable.last_revision."""
2422
 
        try:
2423
 
            return osutils.safe_revision_id(
2424
 
                        self._control_files.get('last-revision').read())
2425
 
        except errors.NoSuchFile:
2426
 
            return None
2427
 
 
2428
 
    def _change_last_revision(self, revision_id):
2429
 
        """See WorkingTree._change_last_revision."""
2430
 
        if revision_id is None or revision_id == NULL_REVISION:
2431
 
            try:
2432
 
                self._control_files._transport.delete('last-revision')
2433
 
            except errors.NoSuchFile:
2434
 
                pass
2435
 
            return False
2436
 
        else:
2437
 
            self._control_files.put_bytes('last-revision', revision_id)
2438
 
            return True
2439
 
 
2440
 
    @needs_tree_write_lock
2441
 
    def set_conflicts(self, conflicts):
2442
 
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2443
 
                      CONFLICT_HEADER_1)
2444
 
 
2445
 
    @needs_tree_write_lock
2446
 
    def add_conflicts(self, new_conflicts):
2447
 
        conflict_set = set(self.conflicts())
2448
 
        conflict_set.update(set(list(new_conflicts)))
2449
 
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2450
 
                                       key=_mod_conflicts.Conflict.sort_key)))
2451
 
 
2452
 
    @needs_read_lock
2453
 
    def conflicts(self):
2454
 
        try:
2455
 
            confile = self._control_files.get('conflicts')
2456
 
        except errors.NoSuchFile:
2457
 
            return _mod_conflicts.ConflictList()
2458
 
        try:
2459
 
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2460
 
                raise errors.ConflictFormatError()
2461
 
        except StopIteration:
2462
 
            raise errors.ConflictFormatError()
2463
 
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2464
 
 
2465
 
    def unlock(self):
2466
 
        if self._control_files._lock_count == 1:
2467
 
            # _inventory_is_modified is always False during a read lock.
2468
 
            if self._inventory_is_modified:
2469
 
                self.flush()
2470
 
            self._write_hashcache_if_dirty()
2471
 
        # reverse order of locking.
2472
 
        try:
2473
 
            return self._control_files.unlock()
2474
 
        finally:
2475
 
            self.branch.unlock()
2476
 
 
2477
 
 
 
384
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
2478
385
def get_conflicted_stem(path):
2479
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
 
386
    for suffix in CONFLICT_SUFFIXES:
2480
387
        if path.endswith(suffix):
2481
388
            return path[:-len(suffix)]
2482
 
 
2483
 
 
2484
 
@deprecated_function(zero_eight)
2485
 
def is_control_file(filename):
2486
 
    """See WorkingTree.is_control_filename(filename)."""
2487
 
    ## FIXME: better check
2488
 
    filename = normpath(filename)
2489
 
    while filename != '':
2490
 
        head, tail = os.path.split(filename)
2491
 
        ## mutter('check %r for control file' % ((head, tail),))
2492
 
        if tail == '.bzr':
2493
 
            return True
2494
 
        if filename == head:
2495
 
            break
2496
 
        filename = head
2497
 
    return False
2498
 
 
2499
 
 
2500
 
class WorkingTreeFormat(object):
2501
 
    """An encapsulation of the initialization and open routines for a format.
2502
 
 
2503
 
    Formats provide three things:
2504
 
     * An initialization routine,
2505
 
     * a format string,
2506
 
     * an open routine.
2507
 
 
2508
 
    Formats are placed in an dict by their format string for reference 
2509
 
    during workingtree opening. Its not required that these be instances, they
2510
 
    can be classes themselves with class methods - it simply depends on 
2511
 
    whether state is needed for a given format or not.
2512
 
 
2513
 
    Once a format is deprecated, just deprecate the initialize and open
2514
 
    methods on the format class. Do not deprecate the object, as the 
2515
 
    object will be created every time regardless.
2516
 
    """
2517
 
 
2518
 
    _default_format = None
2519
 
    """The default format used for new trees."""
2520
 
 
2521
 
    _formats = {}
2522
 
    """The known formats."""
2523
 
 
2524
 
    requires_rich_root = False
2525
 
 
2526
 
    upgrade_recommended = False
2527
 
 
2528
 
    @classmethod
2529
 
    def find_format(klass, a_bzrdir):
2530
 
        """Return the format for the working tree object in a_bzrdir."""
2531
 
        try:
2532
 
            transport = a_bzrdir.get_workingtree_transport(None)
2533
 
            format_string = transport.get("format").read()
2534
 
            return klass._formats[format_string]
2535
 
        except errors.NoSuchFile:
2536
 
            raise errors.NoWorkingTree(base=transport.base)
2537
 
        except KeyError:
2538
 
            raise errors.UnknownFormatError(format=format_string)
2539
 
 
2540
 
    def __eq__(self, other):
2541
 
        return self.__class__ is other.__class__
2542
 
 
2543
 
    def __ne__(self, other):
2544
 
        return not (self == other)
2545
 
 
2546
 
    @classmethod
2547
 
    def get_default_format(klass):
2548
 
        """Return the current default format."""
2549
 
        return klass._default_format
2550
 
 
2551
 
    def get_format_string(self):
2552
 
        """Return the ASCII format string that identifies this format."""
2553
 
        raise NotImplementedError(self.get_format_string)
2554
 
 
2555
 
    def get_format_description(self):
2556
 
        """Return the short description for this format."""
2557
 
        raise NotImplementedError(self.get_format_description)
2558
 
 
2559
 
    def is_supported(self):
2560
 
        """Is this format supported?
2561
 
 
2562
 
        Supported formats can be initialized and opened.
2563
 
        Unsupported formats may not support initialization or committing or 
2564
 
        some other features depending on the reason for not being supported.
2565
 
        """
2566
 
        return True
2567
 
 
2568
 
    @classmethod
2569
 
    def register_format(klass, format):
2570
 
        klass._formats[format.get_format_string()] = format
2571
 
 
2572
 
    @classmethod
2573
 
    def set_default_format(klass, format):
2574
 
        klass._default_format = format
2575
 
 
2576
 
    @classmethod
2577
 
    def unregister_format(klass, format):
2578
 
        assert klass._formats[format.get_format_string()] is format
2579
 
        del klass._formats[format.get_format_string()]
2580
 
 
2581
 
 
2582
 
class WorkingTreeFormat2(WorkingTreeFormat):
2583
 
    """The second working tree format. 
2584
 
 
2585
 
    This format modified the hash cache from the format 1 hash cache.
2586
 
    """
2587
 
 
2588
 
    upgrade_recommended = True
2589
 
 
2590
 
    def get_format_description(self):
2591
 
        """See WorkingTreeFormat.get_format_description()."""
2592
 
        return "Working tree format 2"
2593
 
 
2594
 
    def stub_initialize_remote(self, control_files):
2595
 
        """As a special workaround create critical control files for a remote working tree
2596
 
        
2597
 
        This ensures that it can later be updated and dealt with locally,
2598
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2599
 
        no working tree.  (See bug #43064).
2600
 
        """
2601
 
        sio = StringIO()
2602
 
        inv = Inventory()
2603
 
        xml5.serializer_v5.write_inventory(inv, sio)
2604
 
        sio.seek(0)
2605
 
        control_files.put('inventory', sio)
2606
 
 
2607
 
        control_files.put_bytes('pending-merges', '')
2608
 
        
2609
 
 
2610
 
    def initialize(self, a_bzrdir, revision_id=None):
2611
 
        """See WorkingTreeFormat.initialize()."""
2612
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2613
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2614
 
        branch = a_bzrdir.open_branch()
2615
 
        if revision_id is None:
2616
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2617
 
        else:
2618
 
            revision_id = osutils.safe_revision_id(revision_id)
2619
 
        branch.lock_write()
2620
 
        try:
2621
 
            branch.generate_revision_history(revision_id)
2622
 
        finally:
2623
 
            branch.unlock()
2624
 
        inv = Inventory()
2625
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2626
 
                         branch,
2627
 
                         inv,
2628
 
                         _internal=True,
2629
 
                         _format=self,
2630
 
                         _bzrdir=a_bzrdir)
2631
 
        basis_tree = branch.repository.revision_tree(revision_id)
2632
 
        if basis_tree.inventory.root is not None:
2633
 
            wt.set_root_id(basis_tree.inventory.root.file_id)
2634
 
        # set the parent list and cache the basis tree.
2635
 
        if _mod_revision.is_null(revision_id):
2636
 
            parent_trees = []
2637
 
        else:
2638
 
            parent_trees = [(revision_id, basis_tree)]
2639
 
        wt.set_parent_trees(parent_trees)
2640
 
        transform.build_tree(basis_tree, wt)
2641
 
        return wt
2642
 
 
2643
 
    def __init__(self):
2644
 
        super(WorkingTreeFormat2, self).__init__()
2645
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2646
 
 
2647
 
    def open(self, a_bzrdir, _found=False):
2648
 
        """Return the WorkingTree object for a_bzrdir
2649
 
 
2650
 
        _found is a private parameter, do not use it. It is used to indicate
2651
 
               if format probing has already been done.
2652
 
        """
2653
 
        if not _found:
2654
 
            # we are being called directly and must probe.
2655
 
            raise NotImplementedError
2656
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2657
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2658
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2659
 
                           _internal=True,
2660
 
                           _format=self,
2661
 
                           _bzrdir=a_bzrdir)
2662
 
        return wt
2663
 
 
2664
 
class WorkingTreeFormat3(WorkingTreeFormat):
2665
 
    """The second working tree format updated to record a format marker.
2666
 
 
2667
 
    This format:
2668
 
        - exists within a metadir controlling .bzr
2669
 
        - includes an explicit version marker for the workingtree control
2670
 
          files, separate from the BzrDir format
2671
 
        - modifies the hash cache format
2672
 
        - is new in bzr 0.8
2673
 
        - uses a LockDir to guard access for writes.
2674
 
    """
2675
 
    
2676
 
    upgrade_recommended = True
2677
 
 
2678
 
    def get_format_string(self):
2679
 
        """See WorkingTreeFormat.get_format_string()."""
2680
 
        return "Bazaar-NG Working Tree format 3"
2681
 
 
2682
 
    def get_format_description(self):
2683
 
        """See WorkingTreeFormat.get_format_description()."""
2684
 
        return "Working tree format 3"
2685
 
 
2686
 
    _lock_file_name = 'lock'
2687
 
    _lock_class = LockDir
2688
 
 
2689
 
    _tree_class = WorkingTree3
2690
 
 
2691
 
    def __get_matchingbzrdir(self):
2692
 
        return bzrdir.BzrDirMetaFormat1()
2693
 
 
2694
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2695
 
 
2696
 
    def _open_control_files(self, a_bzrdir):
2697
 
        transport = a_bzrdir.get_workingtree_transport(None)
2698
 
        return LockableFiles(transport, self._lock_file_name, 
2699
 
                             self._lock_class)
2700
 
 
2701
 
    def initialize(self, a_bzrdir, revision_id=None):
2702
 
        """See WorkingTreeFormat.initialize().
2703
 
        
2704
 
        revision_id allows creating a working tree at a different
2705
 
        revision than the branch is at.
2706
 
        """
2707
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2708
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2709
 
        transport = a_bzrdir.get_workingtree_transport(self)
2710
 
        control_files = self._open_control_files(a_bzrdir)
2711
 
        control_files.create_lock()
2712
 
        control_files.lock_write()
2713
 
        control_files.put_utf8('format', self.get_format_string())
2714
 
        branch = a_bzrdir.open_branch()
2715
 
        if revision_id is None:
2716
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2717
 
        else:
2718
 
            revision_id = osutils.safe_revision_id(revision_id)
2719
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2720
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2721
 
        # those trees. And because there isn't a format bump inbetween, we
2722
 
        # are maintaining compatibility with older clients.
2723
 
        # inv = Inventory(root_id=gen_root_id())
2724
 
        inv = self._initial_inventory()
2725
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2726
 
                         branch,
2727
 
                         inv,
2728
 
                         _internal=True,
2729
 
                         _format=self,
2730
 
                         _bzrdir=a_bzrdir,
2731
 
                         _control_files=control_files)
2732
 
        wt.lock_tree_write()
2733
 
        try:
2734
 
            basis_tree = branch.repository.revision_tree(revision_id)
2735
 
            # only set an explicit root id if there is one to set.
2736
 
            if basis_tree.inventory.root is not None:
2737
 
                wt.set_root_id(basis_tree.inventory.root.file_id)
2738
 
            if revision_id == NULL_REVISION:
2739
 
                wt.set_parent_trees([])
2740
 
            else:
2741
 
                wt.set_parent_trees([(revision_id, basis_tree)])
2742
 
            transform.build_tree(basis_tree, wt)
2743
 
        finally:
2744
 
            # Unlock in this order so that the unlock-triggers-flush in
2745
 
            # WorkingTree is given a chance to fire.
2746
 
            control_files.unlock()
2747
 
            wt.unlock()
2748
 
        return wt
2749
 
 
2750
 
    def _initial_inventory(self):
2751
 
        return Inventory()
2752
 
 
2753
 
    def __init__(self):
2754
 
        super(WorkingTreeFormat3, self).__init__()
2755
 
 
2756
 
    def open(self, a_bzrdir, _found=False):
2757
 
        """Return the WorkingTree object for a_bzrdir
2758
 
 
2759
 
        _found is a private parameter, do not use it. It is used to indicate
2760
 
               if format probing has already been done.
2761
 
        """
2762
 
        if not _found:
2763
 
            # we are being called directly and must probe.
2764
 
            raise NotImplementedError
2765
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2766
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2767
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2768
 
        return wt
2769
 
 
2770
 
    def _open(self, a_bzrdir, control_files):
2771
 
        """Open the tree itself.
2772
 
        
2773
 
        :param a_bzrdir: the dir for the tree.
2774
 
        :param control_files: the control files for the tree.
2775
 
        """
2776
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2777
 
                                _internal=True,
2778
 
                                _format=self,
2779
 
                                _bzrdir=a_bzrdir,
2780
 
                                _control_files=control_files)
2781
 
 
2782
 
    def __str__(self):
2783
 
        return self.get_format_string()
2784
 
 
2785
 
 
2786
 
__default_format = WorkingTreeFormat4()
2787
 
WorkingTreeFormat.register_format(__default_format)
2788
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2789
 
WorkingTreeFormat.set_default_format(__default_format)
2790
 
# formats which have no format string are not discoverable
2791
 
# and not independently creatable, so are not registered.
2792
 
_legacy_formats = [WorkingTreeFormat2(),
2793
 
                   ]