~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

Show diffs side-by-side

added added

removed removed

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