~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2005-05-17 07:51:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050517075151-b64853a6a38a6225
- export bzrlib.find_branch

Show diffs side-by-side

added added

removed removed

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