~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2005-09-13 23:08:19 UTC
  • Revision ID: mbp@sourcefrog.net-20050913230819-6ceae96050d32faa
ignore .bzr-shelf

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