/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
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
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
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
 
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
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
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)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
35
 
import sys
36
41
 
37
42
from bzrlib.lazy_import import lazy_import
38
43
lazy_import(globals(), """
39
44
from bisect import bisect_left
40
45
import collections
 
46
from copy import deepcopy
41
47
import errno
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
 
    revision as _mod_revision,
 
67
    osutils,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
65
 
    views,
 
74
    urlutils,
66
75
    xml5,
 
76
    xml6,
67
77
    xml7,
68
78
    )
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
81
import bzrlib.ui
 
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
76
83
""")
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lock import LogicalLockResult
81
 
from bzrlib.lockable_files import LockableFiles
 
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
 
from bzrlib import osutils
86
92
from bzrlib.osutils import (
 
93
    compact_date,
87
94
    file_kind,
88
95
    isdir,
89
96
    normpath,
90
97
    pathjoin,
 
98
    rand_chars,
91
99
    realpath,
92
100
    safe_unicode,
93
101
    splitpath,
94
102
    supports_executable,
95
103
    )
96
 
from bzrlib.filters import filtered_input_file
97
104
from bzrlib.trace import mutter, note
98
105
from bzrlib.transport.local import LocalTransport
99
 
from bzrlib.revision import CURRENT_REVISION
 
106
from bzrlib.progress import DummyProgress, ProgressPhase
 
107
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
108
from bzrlib.rio import RioReader, rio_file, Stanza
101
 
from bzrlib.symbol_versioning import (
102
 
    deprecated_passed,
103
 
    DEPRECATED_PARAMETER,
104
 
    )
 
109
from bzrlib.symbol_versioning import (deprecated_passed,
 
110
        deprecated_method,
 
111
        deprecated_function,
 
112
        DEPRECATED_PARAMETER,
 
113
        zero_eight,
 
114
        zero_eleven,
 
115
        zero_thirteen,
 
116
        )
105
117
 
106
118
 
107
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
 
# TODO: Modifying the conflict objects or their type is currently nearly
109
 
# impossible as there is no clear relationship between the working tree format
110
 
# and the conflict list file format.
111
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
121
 
113
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
122
 
 
123
@deprecated_function(zero_thirteen)
 
124
def gen_file_id(name):
 
125
    """Return new file id for the basename 'name'.
 
126
 
 
127
    Use bzrlib.generate_ids.gen_file_id() instead
 
128
    """
 
129
    return generate_ids.gen_file_id(name)
 
130
 
 
131
 
 
132
@deprecated_function(zero_thirteen)
 
133
def gen_root_id():
 
134
    """Return a new tree-root file id.
 
135
 
 
136
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
137
    """
 
138
    return generate_ids.gen_root_id()
114
139
 
115
140
 
116
141
class TreeEntry(object):
117
142
    """An entry that implements the minimum interface used by commands.
118
143
 
119
 
    This needs further inspection, it may be better to have
 
144
    This needs further inspection, it may be better to have 
120
145
    InventoryEntries without ids - though that seems wrong. For now,
121
146
    this is a parallel hierarchy to InventoryEntry, and needs to become
122
147
    one of several things: decorates to that hierarchy, children of, or
125
150
    no InventoryEntry available - i.e. for unversioned objects.
126
151
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
127
152
    """
128
 
 
 
153
 
129
154
    def __eq__(self, other):
130
155
        # yes, this us ugly, TODO: best practice __eq__ style.
131
156
        return (isinstance(other, TreeEntry)
132
157
                and other.__class__ == self.__class__)
133
 
 
 
158
 
134
159
    def kind_character(self):
135
160
        return "???"
136
161
 
168
193
        return ''
169
194
 
170
195
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
196
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
197
    """Working copy tree.
174
198
 
175
199
    The inventory is held in the `Branch` working-inventory, and the
179
203
    not listed in the Inventory and vice versa.
180
204
    """
181
205
 
182
 
    # override this to set the strategy for storing views
183
 
    def _make_views(self):
184
 
        return views.DisabledViews(self)
185
 
 
186
206
    def __init__(self, basedir='.',
187
207
                 branch=DEPRECATED_PARAMETER,
188
208
                 _inventory=None,
199
219
        if not _internal:
200
220
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
201
221
                "WorkingTree.open() to obtain a WorkingTree.")
 
222
        assert isinstance(basedir, basestring), \
 
223
            "base directory %r is not a string" % basedir
202
224
        basedir = safe_unicode(basedir)
203
225
        mutter("opening working tree %r", basedir)
204
226
        if deprecated_passed(branch):
212
234
            self._control_files = self.branch.control_files
213
235
        else:
214
236
            # assume all other formats have their own control files.
 
237
            assert isinstance(_control_files, LockableFiles), \
 
238
                    "_control_files must be a LockableFiles, not %r" \
 
239
                    % _control_files
215
240
            self._control_files = _control_files
216
 
        self._transport = self._control_files._transport
217
241
        # update the whole cache up front and write to disk if anything changed;
218
242
        # in the future we might want to do this more selectively
219
243
        # two possible ways offer themselves : in self._unlock, write the cache
223
247
        wt_trans = self.bzrdir.get_workingtree_transport(None)
224
248
        cache_filename = wt_trans.local_abspath('stat-cache')
225
249
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
 
            self.bzrdir._get_file_mode(),
227
 
            self._content_filter_stack_provider())
 
250
                                              self._control_files._file_mode)
228
251
        hc = self._hashcache
229
252
        hc.read()
230
253
        # is this scan needed ? it makes things kinda slow.
244
267
            # the Format factory and creation methods that are
245
268
            # permitted to do this.
246
269
            self._set_inventory(_inventory, dirty=False)
247
 
        self._detect_case_handling()
248
 
        self._rules_searcher = None
249
 
        self.views = self._make_views()
250
 
 
251
 
    @property
252
 
    def user_transport(self):
253
 
        return self.bzrdir.user_transport
254
 
 
255
 
    @property
256
 
    def control_transport(self):
257
 
        return self._transport
258
 
 
259
 
    def _detect_case_handling(self):
260
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
261
 
        try:
262
 
            wt_trans.stat("FoRMaT")
263
 
        except errors.NoSuchFile:
264
 
            self.case_sensitive = True
265
 
        else:
266
 
            self.case_sensitive = False
267
 
 
268
 
        self._setup_directory_is_tree_reference()
269
270
 
270
271
    branch = property(
271
272
        fget=lambda self: self._branch,
286
287
        self._control_files.break_lock()
287
288
        self.branch.break_lock()
288
289
 
289
 
    def _get_check_refs(self):
290
 
        """Return the references needed to perform a check of this tree.
291
 
        
292
 
        The default implementation returns no refs, and is only suitable for
293
 
        trees that have no local caching and can commit on ghosts at any time.
294
 
 
295
 
        :seealso: bzrlib.check for details about check_refs.
296
 
        """
297
 
        return []
298
 
 
299
290
    def requires_rich_root(self):
300
291
        return self._format.requires_rich_root
301
292
 
302
293
    def supports_tree_reference(self):
303
294
        return False
304
295
 
305
 
    def supports_content_filtering(self):
306
 
        return self._format.supports_content_filtering()
307
 
 
308
 
    def supports_views(self):
309
 
        return self.views.supports_views()
310
 
 
311
296
    def _set_inventory(self, inv, dirty):
312
297
        """Set the internal cached inventory.
313
298
 
318
303
            False then the inventory is the same as that on disk and any
319
304
            serialisation would be unneeded overhead.
320
305
        """
 
306
        assert inv.root is not None
321
307
        self._inventory = inv
322
308
        self._inventory_is_modified = dirty
323
309
 
327
313
 
328
314
        """
329
315
        if path is None:
330
 
            path = osutils.getcwd()
 
316
            path = os.path.getcwdu()
331
317
        control = bzrdir.BzrDir.open(path, _unsupported)
332
318
        return control.open_workingtree(_unsupported)
333
 
 
 
319
        
334
320
    @staticmethod
335
321
    def open_containing(path=None):
336
322
        """Open an existing working tree which has its root about path.
337
 
 
 
323
        
338
324
        This probes for a working tree at path and searches upwards from there.
339
325
 
340
326
        Basically we keep looking up until we find the control directory or
358
344
        """
359
345
        return WorkingTree.open(path, _unsupported=True)
360
346
 
361
 
    @staticmethod
362
 
    def find_trees(location):
363
 
        def list_current(transport):
364
 
            return [d for d in transport.list_dir('') if d != '.bzr']
365
 
        def evaluate(bzrdir):
366
 
            try:
367
 
                tree = bzrdir.open_workingtree()
368
 
            except errors.NoWorkingTree:
369
 
                return True, None
370
 
            else:
371
 
                return True, tree
372
 
        transport = get_transport(location)
373
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
374
 
                                              list_current=list_current)
375
 
        return [t for t in iterator if t is not None]
376
 
 
377
347
    # should be deprecated - this is slow and in any case treating them as a
378
348
    # container is (we now know) bad style -- mbp 20070302
379
349
    ## @deprecated_method(zero_fifteen)
388
358
            if osutils.lexists(self.abspath(path)):
389
359
                yield ie.file_id
390
360
 
391
 
    def all_file_ids(self):
392
 
        """See Tree.iter_all_file_ids"""
393
 
        return set(self.inventory)
394
 
 
395
361
    def __repr__(self):
396
362
        return "<%s of %s>" % (self.__class__.__name__,
397
363
                               getattr(self, 'basedir', None))
398
364
 
399
365
    def abspath(self, filename):
400
366
        return pathjoin(self.basedir, filename)
401
 
 
 
367
    
402
368
    def basis_tree(self):
403
369
        """Return RevisionTree for the current last revision.
404
 
 
 
370
        
405
371
        If the left most parent is a ghost then the returned tree will be an
406
 
        empty tree - one obtained by calling
407
 
        repository.revision_tree(NULL_REVISION).
 
372
        empty tree - one obtained by calling repository.revision_tree(None).
408
373
        """
409
374
        try:
410
375
            revision_id = self.get_parent_ids()[0]
412
377
            # no parents, return an empty revision tree.
413
378
            # in the future this should return the tree for
414
379
            # 'empty:' - the implicit root empty tree.
415
 
            return self.branch.repository.revision_tree(
416
 
                       _mod_revision.NULL_REVISION)
 
380
            return self.branch.repository.revision_tree(None)
417
381
        try:
418
382
            return self.revision_tree(revision_id)
419
383
        except errors.NoSuchRevision:
423
387
        # at this point ?
424
388
        try:
425
389
            return self.branch.repository.revision_tree(revision_id)
426
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
390
        except errors.RevisionNotPresent:
427
391
            # the basis tree *may* be a ghost or a low level error may have
428
 
            # occurred. If the revision is present, its a problem, if its not
 
392
            # occured. If the revision is present, its a problem, if its not
429
393
            # its a ghost.
430
394
            if self.branch.repository.has_revision(revision_id):
431
395
                raise
432
396
            # the basis tree is a ghost so return an empty tree.
433
 
            return self.branch.repository.revision_tree(
434
 
                       _mod_revision.NULL_REVISION)
435
 
 
436
 
    def _cleanup(self):
437
 
        self._flush_ignore_list_cache()
 
397
            return self.branch.repository.revision_tree(None)
 
398
 
 
399
    @staticmethod
 
400
    @deprecated_method(zero_eight)
 
401
    def create(branch, directory):
 
402
        """Create a workingtree for branch at directory.
 
403
 
 
404
        If existing_directory already exists it must have a .bzr directory.
 
405
        If it does not exist, it will be created.
 
406
 
 
407
        This returns a new WorkingTree object for the new checkout.
 
408
 
 
409
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
410
        should accept an optional revisionid to checkout [and reject this if
 
411
        checking out into the same dir as a pre-checkout-aware branch format.]
 
412
 
 
413
        XXX: When BzrDir is present, these should be created through that 
 
414
        interface instead.
 
415
        """
 
416
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
417
        transport = get_transport(directory)
 
418
        if branch.bzrdir.root_transport.base == transport.base:
 
419
            # same dir 
 
420
            return branch.bzrdir.create_workingtree()
 
421
        # different directory, 
 
422
        # create a branch reference
 
423
        # and now a working tree.
 
424
        raise NotImplementedError
 
425
 
 
426
    @staticmethod
 
427
    @deprecated_method(zero_eight)
 
428
    def create_standalone(directory):
 
429
        """Create a checkout and a branch and a repo at directory.
 
430
 
 
431
        Directory must exist and be empty.
 
432
 
 
433
        please use BzrDir.create_standalone_workingtree
 
434
        """
 
435
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
438
436
 
439
437
    def relpath(self, path):
440
438
        """Return the local path portion from a given path.
441
 
 
442
 
        The path may be absolute or relative. If its a relative path it is
 
439
        
 
440
        The path may be absolute or relative. If its a relative path it is 
443
441
        interpreted relative to the python current working directory.
444
442
        """
445
443
        return osutils.relpath(self.basedir, path)
447
445
    def has_filename(self, filename):
448
446
        return osutils.lexists(self.abspath(filename))
449
447
 
450
 
    def get_file(self, file_id, path=None, filtered=True):
451
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
 
 
453
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
454
 
        _fstat=os.fstat):
455
 
        """See Tree.get_file_with_stat."""
456
 
        if path is None:
457
 
            path = self.id2path(file_id)
458
 
        file_obj = self.get_file_byname(path, filtered=False)
459
 
        stat_value = _fstat(file_obj.fileno())
460
 
        if filtered and self.supports_content_filtering():
461
 
            filters = self._content_filter_stack(path)
462
 
            file_obj = filtered_input_file(file_obj, filters)
463
 
        return (file_obj, stat_value)
464
 
 
465
 
    def get_file_text(self, file_id, path=None, filtered=True):
466
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
467
 
 
468
 
    def get_file_byname(self, filename, filtered=True):
469
 
        path = self.abspath(filename)
470
 
        f = file(path, 'rb')
471
 
        if filtered and self.supports_content_filtering():
472
 
            filters = self._content_filter_stack(filename)
473
 
            return filtered_input_file(f, filters)
474
 
        else:
475
 
            return f
476
 
 
477
 
    def get_file_lines(self, file_id, path=None, filtered=True):
478
 
        """See Tree.get_file_lines()"""
479
 
        file = self.get_file(file_id, path, filtered=filtered)
480
 
        try:
481
 
            return file.readlines()
482
 
        finally:
483
 
            file.close()
 
448
    def get_file(self, file_id):
 
449
        file_id = osutils.safe_file_id(file_id)
 
450
        return self.get_file_byname(self.id2path(file_id))
 
451
 
 
452
    def get_file_text(self, file_id):
 
453
        file_id = osutils.safe_file_id(file_id)
 
454
        return self.get_file(file_id).read()
 
455
 
 
456
    def get_file_byname(self, filename):
 
457
        return file(self.abspath(filename), 'rb')
484
458
 
485
459
    @needs_read_lock
486
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
460
    def annotate_iter(self, file_id):
487
461
        """See Tree.annotate_iter
488
462
 
489
463
        This implementation will use the basis tree implementation if possible.
493
467
        incorrectly attributed to CURRENT_REVISION (but after committing, the
494
468
        attribution will be correct).
495
469
        """
496
 
        maybe_file_parent_keys = []
497
 
        for parent_id in self.get_parent_ids():
498
 
            try:
499
 
                parent_tree = self.revision_tree(parent_id)
500
 
            except errors.NoSuchRevisionInTree:
501
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
502
 
            parent_tree.lock_read()
503
 
            try:
504
 
                if file_id not in parent_tree:
505
 
                    continue
506
 
                ie = parent_tree.inventory[file_id]
507
 
                if ie.kind != 'file':
508
 
                    # Note: this is slightly unnecessary, because symlinks and
509
 
                    # directories have a "text" which is the empty text, and we
510
 
                    # know that won't mess up annotations. But it seems cleaner
511
 
                    continue
512
 
                parent_text_key = (file_id, ie.revision)
513
 
                if parent_text_key not in maybe_file_parent_keys:
514
 
                    maybe_file_parent_keys.append(parent_text_key)
515
 
            finally:
516
 
                parent_tree.unlock()
517
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
518
 
        heads = graph.heads(maybe_file_parent_keys)
519
 
        file_parent_keys = []
520
 
        for key in maybe_file_parent_keys:
521
 
            if key in heads:
522
 
                file_parent_keys.append(key)
523
 
 
524
 
        # Now we have the parents of this content
525
 
        annotator = self.branch.repository.texts.get_annotator()
526
 
        text = self.get_file(file_id).read()
527
 
        this_key =(file_id, default_revision)
528
 
        annotator.add_special_text(this_key, file_parent_keys, text)
529
 
        annotations = [(key[-1], line)
530
 
                       for key, line in annotator.annotate_flat(this_key)]
531
 
        return annotations
532
 
 
533
 
    def _get_ancestors(self, default_revision):
534
 
        ancestors = set([default_revision])
535
 
        for parent_id in self.get_parent_ids():
536
 
            ancestors.update(self.branch.repository.get_ancestry(
537
 
                             parent_id, topo_sorted=False))
538
 
        return ancestors
 
470
        file_id = osutils.safe_file_id(file_id)
 
471
        basis = self.basis_tree()
 
472
        basis.lock_read()
 
473
        try:
 
474
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
475
                require_versioned=True).next()
 
476
            changed_content, kind = changes[2], changes[6]
 
477
            if not changed_content:
 
478
                return basis.annotate_iter(file_id)
 
479
            if kind[1] is None:
 
480
                return None
 
481
            import annotate
 
482
            if kind[0] != 'file':
 
483
                old_lines = []
 
484
            else:
 
485
                old_lines = list(basis.annotate_iter(file_id))
 
486
            old = [old_lines]
 
487
            for tree in self.branch.repository.revision_trees(
 
488
                self.get_parent_ids()[1:]):
 
489
                if file_id not in tree:
 
490
                    continue
 
491
                old.append(list(tree.annotate_iter(file_id)))
 
492
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
493
                                       CURRENT_REVISION)
 
494
        finally:
 
495
            basis.unlock()
539
496
 
540
497
    def get_parent_ids(self):
541
498
        """See Tree.get_parent_ids.
542
 
 
 
499
        
543
500
        This implementation reads the pending merges list and last_revision
544
501
        value and uses that to decide what the parents list should be.
545
502
        """
546
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
547
 
        if _mod_revision.NULL_REVISION == last_rev:
 
503
        last_rev = self._last_revision()
 
504
        if last_rev is None:
548
505
            parents = []
549
506
        else:
550
507
            parents = [last_rev]
551
508
        try:
552
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
509
            merges_file = self._control_files.get('pending-merges')
553
510
        except errors.NoSuchFile:
554
511
            pass
555
512
        else:
556
 
            for l in osutils.split_lines(merges_bytes):
557
 
                revision_id = l.rstrip('\n')
 
513
            for l in merges_file.readlines():
 
514
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
558
515
                parents.append(revision_id)
559
516
        return parents
560
517
 
562
519
    def get_root_id(self):
563
520
        """Return the id of this trees root"""
564
521
        return self._inventory.root.file_id
565
 
 
 
522
        
566
523
    def _get_store_filename(self, file_id):
567
524
        ## XXX: badly named; this is not in the store at all
 
525
        file_id = osutils.safe_file_id(file_id)
568
526
        return self.abspath(self.id2path(file_id))
569
527
 
570
528
    @needs_read_lock
571
529
    def clone(self, to_bzrdir, revision_id=None):
572
530
        """Duplicate this working tree into to_bzr, including all state.
573
 
 
 
531
        
574
532
        Specifically modified files are kept as modified, but
575
533
        ignored and unknown files are discarded.
576
534
 
577
535
        If you want to make a new line of development, see bzrdir.sprout()
578
536
 
579
537
        revision
580
 
            If not None, the cloned tree will have its last revision set to
581
 
            revision, and difference between the source trees last revision
 
538
            If not None, the cloned tree will have its last revision set to 
 
539
            revision, and and difference between the source trees last revision
582
540
            and this one merged in.
583
541
        """
584
542
        # assumes the target bzr dir format is compatible.
585
 
        result = to_bzrdir.create_workingtree()
 
543
        result = self._format.initialize(to_bzrdir)
586
544
        self.copy_content_into(result, revision_id)
587
545
        return result
588
546
 
599
557
            tree.set_parent_ids([revision_id])
600
558
 
601
559
    def id2abspath(self, file_id):
 
560
        file_id = osutils.safe_file_id(file_id)
602
561
        return self.abspath(self.id2path(file_id))
603
562
 
604
563
    def has_id(self, file_id):
605
564
        # files that have been deleted are excluded
 
565
        file_id = osutils.safe_file_id(file_id)
606
566
        inv = self.inventory
607
567
        if not inv.has_id(file_id):
608
568
            return False
610
570
        return osutils.lexists(self.abspath(path))
611
571
 
612
572
    def has_or_had_id(self, file_id):
 
573
        file_id = osutils.safe_file_id(file_id)
613
574
        if file_id == self.inventory.root.file_id:
614
575
            return True
615
576
        return self.inventory.has_id(file_id)
617
578
    __contains__ = has_id
618
579
 
619
580
    def get_file_size(self, file_id):
620
 
        """See Tree.get_file_size"""
621
 
        # XXX: this returns the on-disk size; it should probably return the
622
 
        # canonical size
623
 
        try:
624
 
            return os.path.getsize(self.id2abspath(file_id))
625
 
        except OSError, e:
626
 
            if e.errno != errno.ENOENT:
627
 
                raise
628
 
            else:
629
 
                return None
 
581
        file_id = osutils.safe_file_id(file_id)
 
582
        return os.path.getsize(self.id2abspath(file_id))
630
583
 
631
584
    @needs_read_lock
632
585
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
586
        file_id = osutils.safe_file_id(file_id)
633
587
        if not path:
634
588
            path = self._inventory.id2path(file_id)
635
589
        return self._hashcache.get_sha1(path, stat_value)
636
590
 
637
591
    def get_file_mtime(self, file_id, path=None):
 
592
        file_id = osutils.safe_file_id(file_id)
638
593
        if not path:
639
594
            path = self.inventory.id2path(file_id)
640
595
        return os.lstat(self.abspath(path)).st_mtime
641
596
 
642
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
 
        file_id = self.path2id(path)
644
 
        if file_id is None:
645
 
            # For unversioned files on win32, we just assume they are not
646
 
            # executable
647
 
            return False
648
 
        return self._inventory[file_id].executable
649
 
 
650
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
651
 
        mode = stat_result.st_mode
652
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
 
 
654
597
    if not supports_executable():
655
598
        def is_executable(self, file_id, path=None):
 
599
            file_id = osutils.safe_file_id(file_id)
656
600
            return self._inventory[file_id].executable
657
 
 
658
 
        _is_executable_from_path_and_stat = \
659
 
            _is_executable_from_path_and_stat_from_basis
660
601
    else:
661
602
        def is_executable(self, file_id, path=None):
662
603
            if not path:
 
604
                file_id = osutils.safe_file_id(file_id)
663
605
                path = self.id2path(file_id)
664
606
            mode = os.lstat(self.abspath(path)).st_mode
665
607
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
608
 
667
 
        _is_executable_from_path_and_stat = \
668
 
            _is_executable_from_path_and_stat_from_stat
669
 
 
670
609
    @needs_tree_write_lock
671
610
    def _add(self, files, ids, kinds):
672
611
        """See MutableTree._add."""
673
612
        # TODO: Re-adding a file that is removed in the working copy
674
613
        # should probably put it back with the previous ID.
675
 
        # the read and write working inventory should not occur in this
 
614
        # the read and write working inventory should not occur in this 
676
615
        # function - they should be part of lock_write and unlock.
677
 
        inv = self.inventory
 
616
        inv = self.read_working_inventory()
678
617
        for f, file_id, kind in zip(files, ids, kinds):
 
618
            assert kind is not None
679
619
            if file_id is None:
680
620
                inv.add_path(f, kind=kind)
681
621
            else:
 
622
                file_id = osutils.safe_file_id(file_id)
682
623
                inv.add_path(f, kind=kind, file_id=file_id)
683
 
            self._inventory_is_modified = True
 
624
        self._write_inventory(inv)
684
625
 
685
626
    @needs_tree_write_lock
686
627
    def _gather_kinds(self, files, kinds):
746
687
        if updated:
747
688
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
689
 
749
 
    def path_content_summary(self, path, _lstat=os.lstat,
750
 
        _mapper=osutils.file_kind_from_stat_mode):
751
 
        """See Tree.path_content_summary."""
752
 
        abspath = self.abspath(path)
753
 
        try:
754
 
            stat_result = _lstat(abspath)
755
 
        except OSError, e:
756
 
            if getattr(e, 'errno', None) == errno.ENOENT:
757
 
                # no file.
758
 
                return ('missing', None, None, None)
759
 
            # propagate other errors
760
 
            raise
761
 
        kind = _mapper(stat_result.st_mode)
762
 
        if kind == 'file':
763
 
            return self._file_content_summary(path, stat_result)
764
 
        elif kind == 'directory':
765
 
            # perhaps it looks like a plain directory, but it's really a
766
 
            # reference.
767
 
            if self._directory_is_tree_reference(path):
768
 
                kind = 'tree-reference'
769
 
            return kind, None, None, None
770
 
        elif kind == 'symlink':
771
 
            target = osutils.readlink(abspath)
772
 
            return ('symlink', None, None, target)
773
 
        else:
774
 
            return (kind, None, None, None)
775
 
 
776
 
    def _file_content_summary(self, path, stat_result):
777
 
        size = stat_result.st_size
778
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
779
 
        # try for a stat cache lookup
780
 
        return ('file', size, executable, self._sha_from_stat(
781
 
            path, stat_result))
 
690
    @deprecated_method(zero_eleven)
 
691
    @needs_read_lock
 
692
    def pending_merges(self):
 
693
        """Return a list of pending merges.
 
694
 
 
695
        These are revisions that have been merged into the working
 
696
        directory but not yet committed.
 
697
 
 
698
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
699
        instead - which is available on all tree objects.
 
700
        """
 
701
        return self.get_parent_ids()[1:]
782
702
 
783
703
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
704
        """Common ghost checking functionality from set_parent_*.
794
714
 
795
715
    def _set_merges_from_parent_ids(self, parent_ids):
796
716
        merges = parent_ids[1:]
797
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
 
            mode=self.bzrdir._get_file_mode())
799
 
 
800
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
801
 
        """Check that all merged revisions are proper 'heads'.
802
 
 
803
 
        This will always return the first revision_id, and any merged revisions
804
 
        which are
805
 
        """
806
 
        if len(revision_ids) == 0:
807
 
            return revision_ids
808
 
        graph = self.branch.repository.get_graph()
809
 
        heads = graph.heads(revision_ids)
810
 
        new_revision_ids = revision_ids[:1]
811
 
        for revision_id in revision_ids[1:]:
812
 
            if revision_id in heads and revision_id not in new_revision_ids:
813
 
                new_revision_ids.append(revision_id)
814
 
        if new_revision_ids != revision_ids:
815
 
            trace.mutter('requested to set revision_ids = %s,'
816
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
817
 
        return new_revision_ids
 
717
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
718
 
819
719
    @needs_tree_write_lock
820
720
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
721
        """Set the parent ids to revision_ids.
822
 
 
 
722
        
823
723
        See also set_parent_trees. This api will try to retrieve the tree data
824
724
        for each element of revision_ids from the trees repository. If you have
825
725
        tree data already available, it is more efficient to use
829
729
        :param revision_ids: The revision_ids to set as the parent ids of this
830
730
            working tree. Any of these may be ghosts.
831
731
        """
 
732
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
832
733
        self._check_parents_for_ghosts(revision_ids,
833
734
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
834
 
        for revision_id in revision_ids:
835
 
            _mod_revision.check_not_reserved_id(revision_id)
836
 
 
837
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
735
 
839
736
        if len(revision_ids) > 0:
840
737
            self.set_last_revision(revision_ids[0])
841
738
        else:
842
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
739
            self.set_last_revision(None)
843
740
 
844
741
        self._set_merges_from_parent_ids(revision_ids)
845
742
 
846
743
    @needs_tree_write_lock
847
744
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
848
745
        """See MutableTree.set_parent_trees."""
849
 
        parent_ids = [rev for (rev, tree) in parents_list]
850
 
        for revision_id in parent_ids:
851
 
            _mod_revision.check_not_reserved_id(revision_id)
 
746
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
852
747
 
853
748
        self._check_parents_for_ghosts(parent_ids,
854
749
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
750
 
856
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
 
 
858
751
        if len(parent_ids) == 0:
859
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
752
            leftmost_parent_id = None
860
753
            leftmost_parent_tree = None
861
754
        else:
862
755
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
887
780
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
888
781
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
889
782
 
890
 
    def _sha_from_stat(self, path, stat_result):
891
 
        """Get a sha digest from the tree's stat cache.
892
 
 
893
 
        The default implementation assumes no stat cache is present.
894
 
 
895
 
        :param path: The path.
896
 
        :param stat_result: The stat result being looked up.
897
 
        """
898
 
        return None
899
 
 
900
783
    def _put_rio(self, filename, stanzas, header):
901
784
        self._must_be_locked()
902
785
        my_file = rio_file(stanzas, header)
903
 
        self._transport.put_file(filename, my_file,
904
 
            mode=self.bzrdir._get_file_mode())
 
786
        self._control_files.put(filename, my_file)
905
787
 
906
788
    @needs_write_lock # because merge pulls data into the branch.
907
 
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
 
                          merge_type=None, force=False):
 
789
    def merge_from_branch(self, branch, to_revision=None):
909
790
        """Merge from a branch into this working tree.
910
791
 
911
792
        :param branch: The branch to merge from.
915
796
            branch.last_revision().
916
797
        """
917
798
        from bzrlib.merge import Merger, Merge3Merger
918
 
        merger = Merger(self.branch, this_tree=self)
919
 
        # check that there are no local alterations
920
 
        if not force and self.has_changes():
921
 
            raise errors.UncommittedChanges(self)
922
 
        if to_revision is None:
923
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
924
 
        merger.other_rev_id = to_revision
925
 
        if _mod_revision.is_null(merger.other_rev_id):
926
 
            raise errors.NoCommits(branch)
927
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
 
        merger.other_basis = merger.other_rev_id
929
 
        merger.other_tree = self.branch.repository.revision_tree(
930
 
            merger.other_rev_id)
931
 
        merger.other_branch = branch
932
 
        if from_revision is None:
 
799
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
800
        try:
 
801
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
802
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
803
            merger.pp.next_phase()
 
804
            # check that there are no
 
805
            # local alterations
 
806
            merger.check_basis(check_clean=True, require_commits=False)
 
807
            if to_revision is None:
 
808
                to_revision = branch.last_revision()
 
809
            else:
 
810
                to_revision = osutils.safe_revision_id(to_revision)
 
811
            merger.other_rev_id = to_revision
 
812
            if merger.other_rev_id is None:
 
813
                raise error.NoCommits(branch)
 
814
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
815
            merger.other_basis = merger.other_rev_id
 
816
            merger.other_tree = self.branch.repository.revision_tree(
 
817
                merger.other_rev_id)
 
818
            merger.other_branch = branch
 
819
            merger.pp.next_phase()
933
820
            merger.find_base()
934
 
        else:
935
 
            merger.set_base_revision(from_revision, branch)
936
 
        if merger.base_rev_id == merger.other_rev_id:
937
 
            raise errors.PointlessMerge
938
 
        merger.backup_files = False
939
 
        if merge_type is None:
 
821
            if merger.base_rev_id == merger.other_rev_id:
 
822
                raise errors.PointlessMerge
 
823
            merger.backup_files = False
940
824
            merger.merge_type = Merge3Merger
941
 
        else:
942
 
            merger.merge_type = merge_type
943
 
        merger.set_interesting_files(None)
944
 
        merger.show_base = False
945
 
        merger.reprocess = False
946
 
        conflicts = merger.do_merge()
947
 
        merger.set_pending()
 
825
            merger.set_interesting_files(None)
 
826
            merger.show_base = False
 
827
            merger.reprocess = False
 
828
            conflicts = merger.do_merge()
 
829
            merger.set_pending()
 
830
        finally:
 
831
            pb.finished()
948
832
        return conflicts
949
833
 
950
834
    @needs_read_lock
951
835
    def merge_modified(self):
952
836
        """Return a dictionary of files modified by a merge.
953
837
 
954
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
838
        The list is initialized by WorkingTree.set_merge_modified, which is 
955
839
        typically called after we make some automatic updates to the tree
956
840
        because of a merge.
957
841
 
959
843
        still in the working inventory and have that text hash.
960
844
        """
961
845
        try:
962
 
            hashfile = self._transport.get('merge-hashes')
 
846
            hashfile = self._control_files.get('merge-hashes')
963
847
        except errors.NoSuchFile:
964
848
            return {}
 
849
        merge_hashes = {}
965
850
        try:
966
 
            merge_hashes = {}
967
 
            try:
968
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
 
                    raise errors.MergeModifiedFormatError()
970
 
            except StopIteration:
 
851
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
852
                raise errors.MergeModifiedFormatError()
972
 
            for s in RioReader(hashfile):
973
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
974
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
 
                if file_id not in self.inventory:
976
 
                    continue
977
 
                text_hash = s.get("hash")
978
 
                if text_hash == self.get_file_sha1(file_id):
979
 
                    merge_hashes[file_id] = text_hash
980
 
            return merge_hashes
981
 
        finally:
982
 
            hashfile.close()
 
853
        except StopIteration:
 
854
            raise errors.MergeModifiedFormatError()
 
855
        for s in RioReader(hashfile):
 
856
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
857
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
858
            if file_id not in self.inventory:
 
859
                continue
 
860
            text_hash = s.get("hash")
 
861
            if text_hash == self.get_file_sha1(file_id):
 
862
                merge_hashes[file_id] = text_hash
 
863
        return merge_hashes
983
864
 
984
865
    @needs_write_lock
985
866
    def mkdir(self, path, file_id=None):
991
872
        return file_id
992
873
 
993
874
    def get_symlink_target(self, file_id):
994
 
        abspath = self.id2abspath(file_id)
995
 
        target = osutils.readlink(abspath)
996
 
        return target
 
875
        file_id = osutils.safe_file_id(file_id)
 
876
        return os.readlink(self.id2abspath(file_id))
997
877
 
998
878
    @needs_write_lock
999
879
    def subsume(self, other_tree):
1037
917
            other_tree.unlock()
1038
918
        other_tree.bzrdir.retire_bzrdir()
1039
919
 
1040
 
    def _setup_directory_is_tree_reference(self):
1041
 
        if self._branch.repository._format.supports_tree_reference:
1042
 
            self._directory_is_tree_reference = \
1043
 
                self._directory_may_be_tree_reference
1044
 
        else:
1045
 
            self._directory_is_tree_reference = \
1046
 
                self._directory_is_never_tree_reference
1047
 
 
1048
 
    def _directory_is_never_tree_reference(self, relpath):
1049
 
        return False
1050
 
 
1051
 
    def _directory_may_be_tree_reference(self, relpath):
1052
 
        # as a special case, if a directory contains control files then
1053
 
        # it's a tree reference, except that the root of the tree is not
1054
 
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
 
        # TODO: We could ask all the control formats whether they
1056
 
        # recognize this directory, but at the moment there's no cheap api
1057
 
        # to do that.  Since we probably can only nest bzr checkouts and
1058
 
        # they always use this name it's ok for now.  -- mbp 20060306
1059
 
        #
1060
 
        # FIXME: There is an unhandled case here of a subdirectory
1061
 
        # containing .bzr but not a branch; that will probably blow up
1062
 
        # when you try to commit it.  It might happen if there is a
1063
 
        # checkout in a subdirectory.  This can be avoided by not adding
1064
 
        # it.  mbp 20070306
1065
 
 
1066
920
    @needs_tree_write_lock
1067
921
    def extract(self, file_id, format=None):
1068
922
        """Extract a subtree from this tree.
1069
 
 
 
923
        
1070
924
        A new branch will be created, relative to the path for this tree.
1071
925
        """
1072
926
        self.flush()
1075
929
            transport = self.branch.bzrdir.root_transport
1076
930
            for name in segments:
1077
931
                transport = transport.clone(name)
1078
 
                transport.ensure_base()
 
932
                try:
 
933
                    transport.mkdir('.')
 
934
                except errors.FileExists:
 
935
                    pass
1079
936
            return transport
1080
 
 
 
937
            
1081
938
        sub_path = self.id2path(file_id)
1082
939
        branch_transport = mkdirs(sub_path)
1083
940
        if format is None:
1084
 
            format = self.bzrdir.cloning_metadir()
1085
 
        branch_transport.ensure_base()
 
941
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
 
942
        try:
 
943
            branch_transport.mkdir('.')
 
944
        except errors.FileExists:
 
945
            pass
1086
946
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
947
        try:
1088
948
            repo = branch_bzrdir.find_repository()
1089
949
        except errors.NoRepositoryPresent:
1090
950
            repo = branch_bzrdir.create_repository()
1091
 
        if not repo.supports_rich_root():
1092
 
            raise errors.RootNotRich()
 
951
            assert repo.supports_rich_root()
 
952
        else:
 
953
            if not repo.supports_rich_root():
 
954
                raise errors.RootNotRich()
1093
955
        new_branch = branch_bzrdir.create_branch()
1094
956
        new_branch.pull(self.branch)
1095
957
        for parent_id in self.get_parent_ids():
1097
959
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
960
        if tree_transport.base != branch_transport.base:
1099
961
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
 
                target_branch=new_branch)
 
962
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
963
        else:
1103
964
            tree_bzrdir = branch_bzrdir
1104
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
965
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
966
        wt.set_parent_ids(self.get_parent_ids())
1106
967
        my_inv = self.inventory
1107
 
        child_inv = inventory.Inventory(root_id=None)
 
968
        child_inv = Inventory(root_id=None)
1108
969
        new_root = my_inv[file_id]
1109
970
        my_inv.remove_recursive_id(file_id)
1110
971
        new_root.parent_id = None
1114
975
        return wt
1115
976
 
1116
977
    def _serialize(self, inventory, out_file):
1117
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1118
 
            working=True)
 
978
        xml5.serializer_v5.write_inventory(self._inventory, out_file)
1119
979
 
1120
980
    def _deserialize(selt, in_file):
1121
981
        return xml5.serializer_v5.read_inventory(in_file)
1128
988
        sio = StringIO()
1129
989
        self._serialize(self._inventory, sio)
1130
990
        sio.seek(0)
1131
 
        self._transport.put_file('inventory', sio,
1132
 
            mode=self.bzrdir._get_file_mode())
 
991
        self._control_files.put('inventory', sio)
1133
992
        self._inventory_is_modified = False
1134
993
 
1135
994
    def _kind(self, relpath):
1136
995
        return osutils.file_kind(self.abspath(relpath))
1137
996
 
1138
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
 
        """List all files as (path, class, kind, id, entry).
 
997
    def list_files(self, include_root=False):
 
998
        """Recursively list all files as (path, class, kind, id, entry).
1140
999
 
1141
1000
        Lists, but does not descend into unversioned directories.
 
1001
 
1142
1002
        This does not include files that have been deleted in this
1143
 
        tree. Skips the control directory.
 
1003
        tree.
1144
1004
 
1145
 
        :param include_root: if True, 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
 
1005
        Skips the control directory.
1148
1006
        """
1149
1007
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1008
        # with it. So callers should be careful to always read_lock the tree.
1152
1010
            raise errors.ObjectNotLocked(self)
1153
1011
 
1154
1012
        inv = self.inventory
1155
 
        if from_dir is None and include_root is True:
 
1013
        if include_root is True:
1156
1014
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
1015
        # Convert these into local objects to save lookup times
1158
1016
        pathjoin = osutils.pathjoin
1165
1023
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1024
 
1167
1025
        # 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)
 
1026
        children = os.listdir(self.basedir)
1178
1027
        children.sort()
1179
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1028
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1180
1029
        # use a deque and popleft to keep them sorted, or if we use a plain
1181
1030
        # list and just reverse() them.
1182
1031
        children = collections.deque(children)
1183
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1032
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1033
        while stack:
1185
1034
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1186
1035
 
1202
1051
 
1203
1052
                # absolute path
1204
1053
                fap = from_dir_abspath + '/' + f
1205
 
 
 
1054
                
1206
1055
                f_ie = inv.get_child(from_dir_id, f)
1207
1056
                if f_ie:
1208
1057
                    c = 'V'
1240
1089
                    except KeyError:
1241
1090
                        yield fp[1:], c, fk, None, TreeEntry()
1242
1091
                    continue
1243
 
 
 
1092
                
1244
1093
                if fk != 'directory':
1245
1094
                    continue
1246
1095
 
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
 
1096
                # But do this child first
 
1097
                new_children = os.listdir(fap)
 
1098
                new_children.sort()
 
1099
                new_children = collections.deque(new_children)
 
1100
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1101
                # Break out of inner loop,
 
1102
                # so that we start outer loop with child
 
1103
                break
1256
1104
            else:
1257
1105
                # if we finished all children, pop it off the stack
1258
1106
                stack.pop()
1264
1112
        to_dir must exist in the inventory.
1265
1113
 
1266
1114
        If to_dir exists and is a directory, the files are moved into
1267
 
        it, keeping their old names.
 
1115
        it, keeping their old names.  
1268
1116
 
1269
1117
        Note that to_dir is only the last component of the new name;
1270
1118
        this doesn't change the directory.
1307
1155
                                       DeprecationWarning)
1308
1156
 
1309
1157
        # check destination directory
1310
 
        if isinstance(from_paths, basestring):
1311
 
            raise ValueError()
 
1158
        assert not isinstance(from_paths, basestring)
1312
1159
        inv = self.inventory
1313
1160
        to_abs = self.abspath(to_dir)
1314
1161
        if not isdir(to_abs):
1398
1245
                only_change_inv = True
1399
1246
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
1247
                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
1248
            else:
1406
1249
                # something is wrong, so lets determine what exactly
1407
1250
                if not self.has_filename(from_rel) and \
1410
1253
                        errors.PathsDoNotExist(paths=(str(from_rel),
1411
1254
                        str(to_rel))))
1412
1255
                else:
1413
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1256
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1257
                        extra="(Use --after to update the Bazaar id)")
1414
1258
            rename_entry.only_change_inv = only_change_inv
1415
1259
        return rename_entries
1416
1260
 
1436
1280
        inv = self.inventory
1437
1281
        for entry in moved:
1438
1282
            try:
1439
 
                self._move_entry(WorkingTree._RenameEntry(
1440
 
                    entry.to_rel, entry.from_id,
 
1283
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1284
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1285
                    entry.from_tail, entry.from_parent_id,
1443
1286
                    entry.only_change_inv))
1494
1337
        from_tail = splitpath(from_rel)[-1]
1495
1338
        from_id = inv.path2id(from_rel)
1496
1339
        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]
 
1340
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1341
                errors.NotVersionedError(path=str(from_rel)))
 
1342
        from_entry = inv[from_id]
1508
1343
        from_parent_id = from_entry.parent_id
1509
1344
        to_dir, to_tail = os.path.split(to_rel)
1510
1345
        to_dir_id = inv.path2id(to_dir)
1556
1391
        These are files in the working directory that are not versioned or
1557
1392
        control files or ignored.
1558
1393
        """
1559
 
        # force the extras method to be fully executed before returning, to
 
1394
        # force the extras method to be fully executed before returning, to 
1560
1395
        # prevent race conditions with the lock
1561
1396
        return iter(
1562
1397
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1572
1407
        :raises: NoSuchId if any fileid is not currently versioned.
1573
1408
        """
1574
1409
        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:
 
1410
            file_id = osutils.safe_file_id(file_id)
1578
1411
            if self._inventory.has_id(file_id):
1579
1412
                self._inventory.remove_recursive_id(file_id)
 
1413
            else:
 
1414
                raise errors.NoSuchId(self, file_id)
1580
1415
        if len(file_ids):
1581
 
            # in the future this should just set a dirty bit to wait for the
 
1416
            # in the future this should just set a dirty bit to wait for the 
1582
1417
            # final unlock. However, until all methods of workingtree start
1583
 
            # with the current in -memory inventory rather than triggering
 
1418
            # with the current in -memory inventory rather than triggering 
1584
1419
            # a read, it is more complex - we need to teach read_inventory
1585
1420
            # to know when to read, and when to not read first... and possibly
1586
1421
            # to save first when the in memory one may be corrupted.
1587
1422
            # so for now, we just only write it if it is indeed dirty.
1588
1423
            # - RBC 20060907
1589
1424
            self._write_inventory(self._inventory)
 
1425
    
 
1426
    @deprecated_method(zero_eight)
 
1427
    def iter_conflicts(self):
 
1428
        """List all files in the tree that have text or content conflicts.
 
1429
        DEPRECATED.  Use conflicts instead."""
 
1430
        return self._iter_conflicts()
1590
1431
 
1591
1432
    def _iter_conflicts(self):
1592
1433
        conflicted = set()
1601
1442
 
1602
1443
    @needs_write_lock
1603
1444
    def pull(self, source, overwrite=False, stop_revision=None,
1604
 
             change_reporter=None, possible_transports=None, local=False):
 
1445
             change_reporter=None):
 
1446
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1447
        source.lock_read()
1606
1448
        try:
 
1449
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1450
            pp.next_phase()
1607
1451
            old_revision_info = self.branch.last_revision_info()
1608
1452
            basis_tree = self.basis_tree()
1609
 
            count = self.branch.pull(source, overwrite, stop_revision,
1610
 
                                     possible_transports=possible_transports,
1611
 
                                     local=local)
 
1453
            count = self.branch.pull(source, overwrite, stop_revision)
1612
1454
            new_revision_info = self.branch.last_revision_info()
1613
1455
            if new_revision_info != old_revision_info:
 
1456
                pp.next_phase()
1614
1457
                repository = self.branch.repository
 
1458
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1459
                basis_tree.lock_read()
1616
1460
                try:
1617
1461
                    new_basis_tree = self.branch.basis_tree()
1620
1464
                                new_basis_tree,
1621
1465
                                basis_tree,
1622
1466
                                this_tree=self,
1623
 
                                pb=None,
 
1467
                                pb=pb,
1624
1468
                                change_reporter=change_reporter)
1625
 
                    basis_root_id = basis_tree.get_root_id()
1626
 
                    new_root_id = new_basis_tree.get_root_id()
1627
 
                    if basis_root_id != new_root_id:
1628
 
                        self.set_root_id(new_root_id)
 
1469
                    if (basis_tree.inventory.root is None and
 
1470
                        new_basis_tree.inventory.root is not None):
 
1471
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1629
1472
                finally:
 
1473
                    pb.finished()
1630
1474
                    basis_tree.unlock()
1631
1475
                # TODO - dedup parents list with things merged by pull ?
1632
1476
                # reuse the revisiontree we merged against to set the new
1633
1477
                # tree data.
1634
1478
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
 
                # we have to pull the merge trees out again, because
1636
 
                # merge_inner has set the ids. - this corner is not yet
 
1479
                # we have to pull the merge trees out again, because 
 
1480
                # merge_inner has set the ids. - this corner is not yet 
1637
1481
                # layered well enough to prevent double handling.
1638
1482
                # XXX TODO: Fix the double handling: telling the tree about
1639
1483
                # the already known parent data is wasteful.
1645
1489
            return count
1646
1490
        finally:
1647
1491
            source.unlock()
 
1492
            top_pb.finished()
1648
1493
 
1649
1494
    @needs_write_lock
1650
1495
    def put_file_bytes_non_atomic(self, file_id, bytes):
1651
1496
        """See MutableTree.put_file_bytes_non_atomic."""
 
1497
        file_id = osutils.safe_file_id(file_id)
1652
1498
        stream = file(self.id2abspath(file_id), 'wb')
1653
1499
        try:
1654
1500
            stream.write(bytes)
1676
1522
 
1677
1523
            fl = []
1678
1524
            for subf in os.listdir(dirabs):
1679
 
                if self.bzrdir.is_control_filename(subf):
 
1525
                if subf == '.bzr':
1680
1526
                    continue
1681
1527
                if subf not in dir_entry.children:
1682
 
                    try:
1683
 
                        (subf_norm,
1684
 
                         can_access) = osutils.normalized_filename(subf)
1685
 
                    except UnicodeDecodeError:
1686
 
                        path_os_enc = path.encode(osutils._fs_enc)
1687
 
                        relpath = path_os_enc + '/' + subf
1688
 
                        raise errors.BadFilenameEncoding(relpath,
1689
 
                                                         osutils._fs_enc)
 
1528
                    subf_norm, can_access = osutils.normalized_filename(subf)
1690
1529
                    if subf_norm != subf and can_access:
1691
1530
                        if subf_norm not in dir_entry.children:
1692
1531
                            fl.append(subf_norm)
1693
1532
                    else:
1694
1533
                        fl.append(subf)
1695
 
 
 
1534
            
1696
1535
            fl.sort()
1697
1536
            for subf in fl:
1698
1537
                subp = pathjoin(path, subf)
1714
1553
        if ignoreset is not None:
1715
1554
            return ignoreset
1716
1555
 
1717
 
        ignore_globs = set()
 
1556
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1718
1557
        ignore_globs.update(ignores.get_runtime_ignores())
1719
1558
        ignore_globs.update(ignores.get_user_ignores())
1720
1559
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1735
1574
        r"""Check whether the filename matches an ignore pattern.
1736
1575
 
1737
1576
        Patterns containing '/' or '\' need to match the whole path;
1738
 
        others match against only the last component.  Patterns starting
1739
 
        with '!' are ignore exceptions.  Exceptions take precedence
1740
 
        over regular patterns and cause the filename to not be ignored.
 
1577
        others match against only the last component.
1741
1578
 
1742
1579
        If the file is ignored, returns the pattern which caused it to
1743
1580
        be ignored, otherwise None.  So this can simply be used as a
1744
1581
        boolean if desired."""
1745
1582
        if getattr(self, '_ignoreglobster', None) is None:
1746
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1583
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1584
        return self._ignoreglobster.match(filename)
1748
1585
 
1749
1586
    def kind(self, file_id):
1750
1587
        return file_kind(self.id2abspath(file_id))
1751
1588
 
1752
 
    def stored_kind(self, file_id):
1753
 
        """See Tree.stored_kind"""
1754
 
        return self.inventory[file_id].kind
1755
 
 
1756
1589
    def _comparison_data(self, entry, path):
1757
1590
        abspath = self.abspath(path)
1758
1591
        try:
1789
1622
    @needs_read_lock
1790
1623
    def _last_revision(self):
1791
1624
        """helper for get_parent_ids."""
1792
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1625
        return self.branch.last_revision()
1793
1626
 
1794
1627
    def is_locked(self):
1795
1628
        return self._control_files.is_locked()
1799
1632
            raise errors.ObjectNotLocked(self)
1800
1633
 
1801
1634
    def lock_read(self):
1802
 
        """Lock the tree for reading.
1803
 
 
1804
 
        This also locks the branch, and can be unlocked via self.unlock().
1805
 
 
1806
 
        :return: A bzrlib.lock.LogicalLockResult.
1807
 
        """
 
1635
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1636
        if not self.is_locked():
1809
1637
            self._reset_data()
1810
1638
        self.branch.lock_read()
1811
1639
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return LogicalLockResult(self.unlock)
 
1640
            return self._control_files.lock_read()
1814
1641
        except:
1815
1642
            self.branch.unlock()
1816
1643
            raise
1817
1644
 
1818
1645
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: A bzrlib.lock.LogicalLockResult.
1822
 
        """
 
1646
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1647
        if not self.is_locked():
1824
1648
            self._reset_data()
1825
1649
        self.branch.lock_read()
1826
1650
        try:
1827
 
            self._control_files.lock_write()
1828
 
            return LogicalLockResult(self.unlock)
 
1651
            return self._control_files.lock_write()
1829
1652
        except:
1830
1653
            self.branch.unlock()
1831
1654
            raise
1832
1655
 
1833
1656
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1835
 
 
1836
 
        :return: A bzrlib.lock.LogicalLockResult.
1837
 
        """
 
1657
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1658
        if not self.is_locked():
1839
1659
            self._reset_data()
1840
1660
        self.branch.lock_write()
1841
1661
        try:
1842
 
            self._control_files.lock_write()
1843
 
            return LogicalLockResult(self.unlock)
 
1662
            return self._control_files.lock_write()
1844
1663
        except:
1845
1664
            self.branch.unlock()
1846
1665
            raise
1854
1673
    def _reset_data(self):
1855
1674
        """Reset transient data that cannot be revalidated."""
1856
1675
        self._inventory_is_modified = False
1857
 
        f = self._transport.get('inventory')
1858
 
        try:
1859
 
            result = self._deserialize(f)
1860
 
        finally:
1861
 
            f.close()
 
1676
        result = self._deserialize(self._control_files.get('inventory'))
1862
1677
        self._set_inventory(result, dirty=False)
1863
1678
 
1864
1679
    @needs_tree_write_lock
1865
1680
    def set_last_revision(self, new_revision):
1866
1681
        """Change the last revision in the working tree."""
 
1682
        new_revision = osutils.safe_revision_id(new_revision)
1867
1683
        if self._change_last_revision(new_revision):
1868
1684
            self._cache_basis_inventory(new_revision)
1869
1685
 
1870
1686
    def _change_last_revision(self, new_revision):
1871
1687
        """Template method part of set_last_revision to perform the change.
1872
 
 
 
1688
        
1873
1689
        This is used to allow WorkingTree3 instances to not affect branch
1874
1690
        when their last revision is set.
1875
1691
        """
1876
 
        if _mod_revision.is_null(new_revision):
 
1692
        if new_revision is None:
1877
1693
            self.branch.set_revision_history([])
1878
1694
            return False
1879
1695
        try:
1885
1701
 
1886
1702
    def _write_basis_inventory(self, xml):
1887
1703
        """Write the basis inventory XML to the basis-inventory file"""
 
1704
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1888
1705
        path = self._basis_inventory_name()
1889
1706
        sio = StringIO(xml)
1890
 
        self._transport.put_file(path, sio,
1891
 
            mode=self.bzrdir._get_file_mode())
 
1707
        self._control_files.put(path, sio)
1892
1708
 
1893
1709
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
1710
        """Create the text that will be saved in basis-inventory"""
1895
 
        inventory.revision_id = revision_id
 
1711
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1712
        #       as all callers should have already converted the revision_id to
 
1713
        #       utf8
 
1714
        inventory.revision_id = osutils.safe_revision_id(revision_id)
1896
1715
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1897
1716
 
1898
1717
    def _cache_basis_inventory(self, new_revision):
1901
1720
        # as commit already has that ready-to-use [while the format is the
1902
1721
        # same, that is].
1903
1722
        try:
1904
 
            # this double handles the inventory - unpack and repack -
 
1723
            # this double handles the inventory - unpack and repack - 
1905
1724
            # but is easier to understand. We can/should put a conditional
1906
1725
            # in here based on whether the inventory is in the latest format
1907
1726
            # - perhaps we should repack all inventories on a repository
1908
1727
            # upgrade ?
1909
1728
            # the fast path is to copy the raw xml from the repository. If the
1910
 
            # xml contains 'revision_id="', then we assume the right
 
1729
            # xml contains 'revision_id="', then we assume the right 
1911
1730
            # revision_id is set. We must check for this full string, because a
1912
1731
            # root node id can legitimately look like 'revision_id' but cannot
1913
1732
            # contain a '"'.
1914
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1733
            xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1734
            firstline = xml.split('\n', 1)[0]
1916
 
            if (not 'revision_id="' in firstline or
 
1735
            if (not 'revision_id="' in firstline or 
1917
1736
                'format="7"' not in firstline):
1918
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1919
 
                    xml, new_revision)
 
1737
                inv = self.branch.repository.deserialise_inventory(
 
1738
                    new_revision, xml)
1920
1739
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1740
            self._write_basis_inventory(xml)
1922
1741
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1744
    def read_basis_inventory(self):
1926
1745
        """Read the cached basis inventory."""
1927
1746
        path = self._basis_inventory_name()
1928
 
        return self._transport.get_bytes(path)
1929
 
 
 
1747
        return self._control_files.get(path).read()
 
1748
        
1930
1749
    @needs_read_lock
1931
1750
    def read_working_inventory(self):
1932
1751
        """Read the working inventory.
1933
 
 
 
1752
        
1934
1753
        :raises errors.InventoryModified: read_working_inventory will fail
1935
1754
            when the current in memory inventory has been modified.
1936
1755
        """
1937
 
        # conceptually this should be an implementation detail of the tree.
 
1756
        # conceptually this should be an implementation detail of the tree. 
1938
1757
        # XXX: Deprecate this.
1939
1758
        # ElementTree does its own conversion from UTF-8, so open in
1940
1759
        # binary.
1941
1760
        if self._inventory_is_modified:
1942
1761
            raise errors.InventoryModified(self)
1943
 
        f = self._transport.get('inventory')
1944
 
        try:
1945
 
            result = self._deserialize(f)
1946
 
        finally:
1947
 
            f.close()
 
1762
        result = self._deserialize(self._control_files.get('inventory'))
1948
1763
        self._set_inventory(result, dirty=False)
1949
1764
        return result
1950
1765
 
1951
1766
    @needs_tree_write_lock
1952
 
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1953
 
        force=False):
1954
 
        """Remove nominated files from the working inventory.
1955
 
 
1956
 
        :files: File paths relative to the basedir.
1957
 
        :keep_files: If true, the files will also be kept.
1958
 
        :force: Delete files and directories, even if they are changed and
1959
 
            even if the directories are not empty.
 
1767
    def remove(self, files, verbose=False, to_file=None):
 
1768
        """Remove nominated files from the working inventory..
 
1769
 
 
1770
        This does not remove their text.  This does not run on XXX on what? RBC
 
1771
 
 
1772
        TODO: Refuse to remove modified files unless --force is given?
 
1773
 
 
1774
        TODO: Do something useful with directories.
 
1775
 
 
1776
        TODO: Should this remove the text or not?  Tough call; not
 
1777
        removing may be useful and the user can just use use rm, and
 
1778
        is the opposite of add.  Removing it is consistent with most
 
1779
        other tools.  Maybe an option.
1960
1780
        """
 
1781
        ## TODO: Normalize names
 
1782
        ## TODO: Remove nested loops; better scalability
1961
1783
        if isinstance(files, basestring):
1962
1784
            files = [files]
1963
1785
 
1964
 
        inv_delta = []
1965
 
 
1966
 
        new_files=set()
1967
 
        unknown_nested_files=set()
1968
 
        if to_file is None:
1969
 
            to_file = sys.stdout
1970
 
 
1971
 
        def recurse_directory_to_add_files(directory):
1972
 
            # Recurse directory and add all files
1973
 
            # so we can check if they have changed.
1974
 
            for parent_info, file_infos in\
1975
 
                self.walkdirs(directory):
1976
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1977
 
                    # Is it versioned or ignored?
1978
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
1979
 
                        # Add nested content for deletion.
1980
 
                        new_files.add(relpath)
1981
 
                    else:
1982
 
                        # Files which are not versioned and not ignored
1983
 
                        # should be treated as unknown.
1984
 
                        unknown_nested_files.add((relpath, None, kind))
1985
 
 
1986
 
        for filename in files:
1987
 
            # Get file name into canonical form.
1988
 
            abspath = self.abspath(filename)
1989
 
            filename = self.relpath(abspath)
1990
 
            if len(filename) > 0:
1991
 
                new_files.add(filename)
1992
 
                recurse_directory_to_add_files(filename)
1993
 
 
1994
 
        files = list(new_files)
1995
 
 
1996
 
        if len(files) == 0:
1997
 
            return # nothing to do
1998
 
 
1999
 
        # Sort needed to first handle directory content before the directory
2000
 
        files.sort(reverse=True)
2001
 
 
2002
 
        # Bail out if we are going to delete files we shouldn't
2003
 
        if not keep_files and not force:
2004
 
            has_changed_files = len(unknown_nested_files) > 0
2005
 
            if not has_changed_files:
2006
 
                for (file_id, path, content_change, versioned, parent_id, name,
2007
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
2008
 
                         include_unchanged=True, require_versioned=False,
2009
 
                         want_unversioned=True, specific_files=files):
2010
 
                    if versioned == (False, False):
2011
 
                        # The record is unknown ...
2012
 
                        if not self.is_ignored(path[1]):
2013
 
                            # ... but not ignored
2014
 
                            has_changed_files = True
2015
 
                            break
2016
 
                    elif content_change and (kind[1] is not None):
2017
 
                        # Versioned and changed, but not deleted
2018
 
                        has_changed_files = True
2019
 
                        break
2020
 
 
2021
 
            if has_changed_files:
2022
 
                # Make delta show ALL applicable changes in error message.
2023
 
                tree_delta = self.changes_from(self.basis_tree(),
2024
 
                    require_versioned=False, want_unversioned=True,
2025
 
                    specific_files=files)
2026
 
                for unknown_file in unknown_nested_files:
2027
 
                    if unknown_file not in tree_delta.unversioned:
2028
 
                        tree_delta.unversioned.extend((unknown_file,))
2029
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2030
 
 
2031
 
        # Build inv_delta and delete files where applicable,
2032
 
        # do this before any modifications to inventory.
 
1786
        inv = self.inventory
 
1787
 
 
1788
        # do this before any modifications
2033
1789
        for f in files:
2034
 
            fid = self.path2id(f)
2035
 
            message = None
 
1790
            fid = inv.path2id(f)
2036
1791
            if not fid:
2037
 
                message = "%s is not versioned." % (f,)
 
1792
                note("%s is not versioned."%f)
2038
1793
            else:
2039
1794
                if verbose:
2040
 
                    # having removed it, it must be either ignored or unknown
 
1795
                    # having remove it, it must be either ignored or unknown
2041
1796
                    if self.is_ignored(f):
2042
1797
                        new_status = 'I'
2043
1798
                    else:
2044
1799
                        new_status = '?'
2045
 
                    # XXX: Really should be a more abstract reporter interface
2046
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2047
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
2048
 
                # Unversion file
2049
 
                inv_delta.append((f, None, fid, None))
2050
 
                message = "removed %s" % (f,)
2051
 
 
2052
 
            if not keep_files:
2053
 
                abs_path = self.abspath(f)
2054
 
                if osutils.lexists(abs_path):
2055
 
                    if (osutils.isdir(abs_path) and
2056
 
                        len(os.listdir(abs_path)) > 0):
2057
 
                        if force:
2058
 
                            osutils.rmtree(abs_path)
2059
 
                        else:
2060
 
                            message = "%s is not an empty directory "\
2061
 
                                "and won't be deleted." % (f,)
2062
 
                    else:
2063
 
                        osutils.delete_any(abs_path)
2064
 
                        message = "deleted %s" % (f,)
2065
 
                elif message is not None:
2066
 
                    # Only care if we haven't done anything yet.
2067
 
                    message = "%s does not exist." % (f,)
2068
 
 
2069
 
            # Print only one message (if any) per file.
2070
 
            if message is not None:
2071
 
                note(message)
2072
 
        self.apply_inventory_delta(inv_delta)
 
1800
                    textui.show_status(new_status, inv[fid].kind, f,
 
1801
                                       to_file=to_file)
 
1802
                del inv[fid]
 
1803
 
 
1804
        self._write_inventory(inv)
2073
1805
 
2074
1806
    @needs_tree_write_lock
2075
 
    def revert(self, filenames=None, old_tree=None, backups=True,
2076
 
               pb=None, report_changes=False):
 
1807
    def revert(self, filenames, old_tree=None, backups=True, 
 
1808
               pb=DummyProgress(), report_changes=False):
2077
1809
        from bzrlib.conflicts import resolve
2078
 
        if filenames == []:
2079
 
            filenames = None
2080
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2081
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2082
 
                DeprecationWarning, stacklevel=2)
2083
1810
        if old_tree is None:
2084
 
            basis_tree = self.basis_tree()
2085
 
            basis_tree.lock_read()
2086
 
            old_tree = basis_tree
 
1811
            old_tree = self.basis_tree()
 
1812
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1813
                                     report_changes)
 
1814
        if not len(filenames):
 
1815
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1816
            resolve(self)
2087
1817
        else:
2088
 
            basis_tree = None
2089
 
        try:
2090
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2091
 
                                         report_changes)
2092
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2093
 
                parent_trees = []
2094
 
                last_revision = self.last_revision()
2095
 
                if last_revision != _mod_revision.NULL_REVISION:
2096
 
                    if basis_tree is None:
2097
 
                        basis_tree = self.basis_tree()
2098
 
                        basis_tree.lock_read()
2099
 
                    parent_trees.append((last_revision, basis_tree))
2100
 
                self.set_parent_trees(parent_trees)
2101
 
                resolve(self)
2102
 
            else:
2103
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2104
 
        finally:
2105
 
            if basis_tree is not None:
2106
 
                basis_tree.unlock()
 
1818
            resolve(self, filenames, ignore_misses=True)
2107
1819
        return conflicts
2108
1820
 
2109
1821
    def revision_tree(self, revision_id):
2136
1848
    def set_inventory(self, new_inventory_list):
2137
1849
        from bzrlib.inventory import (Inventory,
2138
1850
                                      InventoryDirectory,
 
1851
                                      InventoryEntry,
2139
1852
                                      InventoryFile,
2140
1853
                                      InventoryLink)
2141
1854
        inv = Inventory(self.get_root_id())
2143
1856
            name = os.path.basename(path)
2144
1857
            if name == "":
2145
1858
                continue
2146
 
            # fixme, there should be a factory function inv,add_??
 
1859
            # fixme, there should be a factory function inv,add_?? 
2147
1860
            if kind == 'directory':
2148
1861
                inv.add(InventoryDirectory(file_id, name, parent))
2149
1862
            elif kind == 'file':
2157
1870
    @needs_tree_write_lock
2158
1871
    def set_root_id(self, file_id):
2159
1872
        """Set the root id for this tree."""
2160
 
        # for compatability
 
1873
        # for compatability 
2161
1874
        if file_id is None:
2162
 
            raise ValueError(
2163
 
                'WorkingTree.set_root_id with fileid=None')
2164
 
        file_id = osutils.safe_file_id(file_id)
 
1875
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1876
                % 'WorkingTree.set_root_id with fileid=None',
 
1877
                DeprecationWarning,
 
1878
                stacklevel=3)
 
1879
            file_id = ROOT_ID
 
1880
        else:
 
1881
            file_id = osutils.safe_file_id(file_id)
2165
1882
        self._set_root_id(file_id)
2166
1883
 
2167
1884
    def _set_root_id(self, file_id):
2168
1885
        """Set the root id for this tree, in a format specific manner.
2169
1886
 
2170
 
        :param file_id: The file id to assign to the root. It must not be
 
1887
        :param file_id: The file id to assign to the root. It must not be 
2171
1888
            present in the current inventory or an error will occur. It must
2172
1889
            not be None, but rather a valid file id.
2173
1890
        """
2192
1909
 
2193
1910
    def unlock(self):
2194
1911
        """See Branch.unlock.
2195
 
 
 
1912
        
2196
1913
        WorkingTree locking just uses the Branch locking facilities.
2197
1914
        This is current because all working trees have an embedded branch
2198
1915
        within them. IF in the future, we were to make branch data shareable
2199
 
        between multiple working trees, i.e. via shared storage, then we
 
1916
        between multiple working trees, i.e. via shared storage, then we 
2200
1917
        would probably want to lock both the local tree, and the branch.
2201
1918
        """
2202
1919
        raise NotImplementedError(self.unlock)
2203
1920
 
2204
 
    _marker = object()
2205
 
 
2206
 
    def update(self, change_reporter=None, possible_transports=None,
2207
 
               revision=None, old_tip=_marker):
 
1921
    def update(self):
2208
1922
        """Update a working tree along its branch.
2209
1923
 
2210
1924
        This will update the branch if its bound too, which means we have
2228
1942
        - Merge current state -> basis tree of the master w.r.t. the old tree
2229
1943
          basis.
2230
1944
        - Do a 'normal' merge of the old branch basis if it is relevant.
2231
 
 
2232
 
        :param revision: The target revision to update to. Must be in the
2233
 
            revision history.
2234
 
        :param old_tip: If branch.update() has already been run, the value it
2235
 
            returned (old tip of the branch or None). _marker is used
2236
 
            otherwise.
2237
1945
        """
2238
 
        if self.branch.get_bound_location() is not None:
 
1946
        if self.branch.get_master_branch() is not None:
2239
1947
            self.lock_write()
2240
 
            update_branch = (old_tip is self._marker)
 
1948
            update_branch = True
2241
1949
        else:
2242
1950
            self.lock_tree_write()
2243
1951
            update_branch = False
2244
1952
        try:
2245
1953
            if update_branch:
2246
 
                old_tip = self.branch.update(possible_transports)
 
1954
                old_tip = self.branch.update()
2247
1955
            else:
2248
 
                if old_tip is self._marker:
2249
 
                    old_tip = None
2250
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1956
                old_tip = None
 
1957
            return self._update_tree(old_tip)
2251
1958
        finally:
2252
1959
            self.unlock()
2253
1960
 
2254
1961
    @needs_tree_write_lock
2255
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1962
    def _update_tree(self, old_tip=None):
2256
1963
        """Update a tree to the master branch.
2257
1964
 
2258
1965
        :param old_tip: if supplied, the previous tip revision the branch,
2264
1971
        # cant set that until we update the working trees last revision to be
2265
1972
        # one from the new branch, because it will just get absorbed by the
2266
1973
        # parent de-duplication logic.
2267
 
        #
 
1974
        # 
2268
1975
        # We MUST save it even if an error occurs, because otherwise the users
2269
1976
        # local work is unreferenced and will appear to have been lost.
2270
 
        #
2271
 
        nb_conflicts = 0
 
1977
        # 
 
1978
        result = 0
2272
1979
        try:
2273
1980
            last_rev = self.get_parent_ids()[0]
2274
1981
        except IndexError:
2275
 
            last_rev = _mod_revision.NULL_REVISION
2276
 
        if revision is None:
2277
 
            revision = self.branch.last_revision()
2278
 
 
2279
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2280
 
 
2281
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2282
 
            # the branch we are bound to was updated
2283
 
            # merge those changes in first
2284
 
            base_tree  = self.basis_tree()
2285
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2286
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2287
 
                                             base_tree, this_tree=self,
2288
 
                                             change_reporter=change_reporter)
2289
 
            if nb_conflicts:
2290
 
                self.add_parent_tree((old_tip, other_tree))
2291
 
                trace.note('Rerun update after fixing the conflicts.')
2292
 
                return nb_conflicts
2293
 
 
2294
 
        if last_rev != _mod_revision.ensure_null(revision):
2295
 
            # the working tree is up to date with the branch
2296
 
            # we can merge the specified revision from master
2297
 
            to_tree = self.branch.repository.revision_tree(revision)
2298
 
            to_root_id = to_tree.get_root_id()
2299
 
 
 
1982
            last_rev = None
 
1983
        if last_rev != self.branch.last_revision():
 
1984
            # merge tree state up to new branch tip.
2300
1985
            basis = self.basis_tree()
2301
1986
            basis.lock_read()
2302
1987
            try:
2303
 
                if (basis.inventory.root is None
2304
 
                    or basis.inventory.root.file_id != to_root_id):
2305
 
                    self.set_root_id(to_root_id)
 
1988
                to_tree = self.branch.basis_tree()
 
1989
                if basis.inventory.root is None:
 
1990
                    self.set_root_id(to_tree.inventory.root.file_id)
2306
1991
                    self.flush()
 
1992
                result += merge.merge_inner(
 
1993
                                      self.branch,
 
1994
                                      to_tree,
 
1995
                                      basis,
 
1996
                                      this_tree=self)
2307
1997
            finally:
2308
1998
                basis.unlock()
2309
 
 
2310
 
            # determine the branch point
2311
 
            graph = self.branch.repository.get_graph()
2312
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2313
 
                                                last_rev)
2314
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2315
 
 
2316
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2317
 
                                             this_tree=self,
2318
 
                                             change_reporter=change_reporter)
2319
 
            self.set_last_revision(revision)
2320
1999
            # TODO - dedup parents list with things merged by pull ?
2321
2000
            # reuse the tree we've updated to to set the basis:
2322
 
            parent_trees = [(revision, to_tree)]
 
2001
            parent_trees = [(self.branch.last_revision(), to_tree)]
2323
2002
            merges = self.get_parent_ids()[1:]
2324
2003
            # Ideally we ask the tree for the trees here, that way the working
2325
 
            # tree can decide whether to give us the entire tree or give us a
 
2004
            # tree can decide whether to give us teh entire tree or give us a
2326
2005
            # lazy initialised tree. dirstate for instance will have the trees
2327
2006
            # in ram already, whereas a last-revision + basis-inventory tree
2328
2007
            # will not, but also does not need them when setting parents.
2329
2008
            for parent in merges:
2330
2009
                parent_trees.append(
2331
2010
                    (parent, self.branch.repository.revision_tree(parent)))
2332
 
            if not _mod_revision.is_null(old_tip):
 
2011
            if old_tip is not None:
2333
2012
                parent_trees.append(
2334
2013
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2335
2014
            self.set_parent_trees(parent_trees)
2336
2015
            last_rev = parent_trees[0][0]
2337
 
        return nb_conflicts
 
2016
        else:
 
2017
            # the working tree had the same last-revision as the master
 
2018
            # branch did. We may still have pivot local work from the local
 
2019
            # branch into old_tip:
 
2020
            if old_tip is not None:
 
2021
                self.add_parent_tree_id(old_tip)
 
2022
        if old_tip and old_tip != last_rev:
 
2023
            # our last revision was not the prior branch last revision
 
2024
            # and we have converted that last revision to a pending merge.
 
2025
            # base is somewhere between the branch tip now
 
2026
            # and the now pending merge
 
2027
 
 
2028
            # Since we just modified the working tree and inventory, flush out
 
2029
            # the current state, before we modify it again.
 
2030
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2031
            #       requires it only because TreeTransform directly munges the
 
2032
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2033
            #       should be able to remove this extra flush.
 
2034
            self.flush()
 
2035
            from bzrlib.revision import common_ancestor
 
2036
            try:
 
2037
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
2038
                                              old_tip,
 
2039
                                              self.branch.repository)
 
2040
            except errors.NoCommonAncestor:
 
2041
                base_rev_id = None
 
2042
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2043
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2044
            result += merge.merge_inner(
 
2045
                                  self.branch,
 
2046
                                  other_tree,
 
2047
                                  base_tree,
 
2048
                                  this_tree=self)
 
2049
        return result
2338
2050
 
2339
2051
    def _write_hashcache_if_dirty(self):
2340
2052
        """Write out the hashcache if it is dirty."""
2391
2103
    def walkdirs(self, prefix=""):
2392
2104
        """Walk the directories of this tree.
2393
2105
 
2394
 
        returns a generator which yields items in the form:
2395
 
                ((curren_directory_path, fileid),
2396
 
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2397
 
                   file1_kind), ... ])
2398
 
 
2399
2106
        This API returns a generator, which is only valid during the current
2400
2107
        tree transaction - within a single lock_read or lock_write duration.
2401
2108
 
2402
 
        If the tree is not locked, it may cause an error to be raised,
2403
 
        depending on the tree implementation.
 
2109
        If the tree is not locked, it may cause an error to be raised, depending
 
2110
        on the tree implementation.
2404
2111
        """
2405
2112
        disk_top = self.abspath(prefix)
2406
2113
        if disk_top.endswith('/'):
2412
2119
            current_disk = disk_iterator.next()
2413
2120
            disk_finished = False
2414
2121
        except OSError, e:
2415
 
            if not (e.errno == errno.ENOENT or
2416
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
2122
            if e.errno != errno.ENOENT:
2417
2123
                raise
2418
2124
            current_disk = None
2419
2125
            disk_finished = True
2424
2130
            current_inv = None
2425
2131
            inv_finished = True
2426
2132
        while not inv_finished or not disk_finished:
2427
 
            if current_disk:
2428
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2429
 
                    cur_disk_dir_content) = current_disk
2430
 
            else:
2431
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2432
 
                    cur_disk_dir_content) = ((None, None), None)
2433
2133
            if not disk_finished:
2434
2134
                # strip out .bzr dirs
2435
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2436
 
                    len(cur_disk_dir_content) > 0):
2437
 
                    # osutils.walkdirs can be made nicer -
 
2135
                if current_disk[0][1][top_strip_len:] == '':
 
2136
                    # osutils.walkdirs can be made nicer - 
2438
2137
                    # yield the path-from-prefix rather than the pathjoined
2439
2138
                    # value.
2440
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2441
 
                        ('.bzr', '.bzr'))
2442
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2443
 
                        and self.bzrdir.is_control_filename(
2444
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2139
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2140
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2445
2141
                        # we dont yield the contents of, or, .bzr itself.
2446
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2142
                        del current_disk[1][bzrdir_loc]
2447
2143
            if inv_finished:
2448
2144
                # everything is unknown
2449
2145
                direction = 1
2451
2147
                # everything is missing
2452
2148
                direction = -1
2453
2149
            else:
2454
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2150
                direction = cmp(current_inv[0][0], current_disk[0][0])
2455
2151
            if direction > 0:
2456
2152
                # disk is before inventory - unknown
2457
2153
                dirblock = [(relpath, basename, kind, stat, None, None) for
2458
 
                    relpath, basename, kind, stat, top_path in
2459
 
                    cur_disk_dir_content]
2460
 
                yield (cur_disk_dir_relpath, None), dirblock
 
2154
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2155
                yield (current_disk[0][0], None), dirblock
2461
2156
                try:
2462
2157
                    current_disk = disk_iterator.next()
2463
2158
                except StopIteration:
2465
2160
            elif direction < 0:
2466
2161
                # inventory is before disk - missing.
2467
2162
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2468
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2163
                    for relpath, basename, dkind, stat, fileid, kind in 
2469
2164
                    current_inv[1]]
2470
2165
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2471
2166
                try:
2477
2172
                # merge the inventory and disk data together
2478
2173
                dirblock = []
2479
2174
                for relpath, subiterator in itertools.groupby(sorted(
2480
 
                    current_inv[1] + cur_disk_dir_content,
2481
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2175
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2482
2176
                    path_elements = list(subiterator)
2483
2177
                    if len(path_elements) == 2:
2484
2178
                        inv_row, disk_row = path_elements
2510
2204
                    disk_finished = True
2511
2205
 
2512
2206
    def _walkdirs(self, prefix=""):
2513
 
        """Walk the directories of this tree.
2514
 
 
2515
 
           :prefix: is used as the directrory to start with.
2516
 
           returns a generator which yields items in the form:
2517
 
                ((curren_directory_path, fileid),
2518
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2519
 
                   file1_kind), ... ])
2520
 
        """
2521
2207
        _directory = 'directory'
2522
2208
        # get the root in the inventory
2523
2209
        inv = self.inventory
2537
2223
                relroot = ""
2538
2224
            # FIXME: stash the node in pending
2539
2225
            entry = inv[top_id]
2540
 
            if entry.kind == 'directory':
2541
 
                for name, child in entry.sorted_children():
2542
 
                    dirblock.append((relroot + name, name, child.kind, None,
2543
 
                        child.file_id, child.kind
2544
 
                        ))
 
2226
            for name, child in entry.sorted_children():
 
2227
                dirblock.append((relroot + name, name, child.kind, None,
 
2228
                    child.file_id, child.kind
 
2229
                    ))
2545
2230
            yield (currentdir[0], entry.file_id), dirblock
2546
2231
            # push the user specified dirs from dirblock
2547
2232
            for dir in reversed(dirblock):
2580
2265
        self.set_conflicts(un_resolved)
2581
2266
        return un_resolved, resolved
2582
2267
 
2583
 
    @needs_read_lock
2584
 
    def _check(self, references):
2585
 
        """Check the tree for consistency.
2586
 
 
2587
 
        :param references: A dict with keys matching the items returned by
2588
 
            self._get_check_refs(), and values from looking those keys up in
2589
 
            the repository.
2590
 
        """
2591
 
        tree_basis = self.basis_tree()
2592
 
        tree_basis.lock_read()
2593
 
        try:
2594
 
            repo_basis = references[('trees', self.last_revision())]
2595
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2596
 
                raise errors.BzrCheckError(
2597
 
                    "Mismatched basis inventory content.")
2598
 
            self._validate()
2599
 
        finally:
2600
 
            tree_basis.unlock()
2601
 
 
2602
2268
    def _validate(self):
2603
2269
        """Validate internal structures.
2604
2270
 
2610
2276
        """
2611
2277
        return
2612
2278
 
2613
 
    def _get_rules_searcher(self, default_searcher):
2614
 
        """See Tree._get_rules_searcher."""
2615
 
        if self._rules_searcher is None:
2616
 
            self._rules_searcher = super(WorkingTree,
2617
 
                self)._get_rules_searcher(default_searcher)
2618
 
        return self._rules_searcher
2619
 
 
2620
 
    def get_shelf_manager(self):
2621
 
        """Return the ShelfManager for this WorkingTree."""
2622
 
        from bzrlib.shelf import ShelfManager
2623
 
        return ShelfManager(self, self._transport)
2624
 
 
2625
2279
 
2626
2280
class WorkingTree2(WorkingTree):
2627
2281
    """This is the Format 2 working tree.
2628
2282
 
2629
 
    This was the first weave based working tree.
 
2283
    This was the first weave based working tree. 
2630
2284
     - uses os locks for locking.
2631
2285
     - uses the branch last-revision.
2632
2286
    """
2642
2296
        if self._inventory is None:
2643
2297
            self.read_working_inventory()
2644
2298
 
2645
 
    def _get_check_refs(self):
2646
 
        """Return the references needed to perform a check of this tree."""
2647
 
        return [('trees', self.last_revision())]
2648
 
 
2649
2299
    def lock_tree_write(self):
2650
2300
        """See WorkingTree.lock_tree_write().
2651
2301
 
2652
2302
        In Format2 WorkingTrees we have a single lock for the branch and tree
2653
2303
        so lock_tree_write() degrades to lock_write().
2654
 
 
2655
 
        :return: An object with an unlock method which will release the lock
2656
 
            obtained.
2657
2304
        """
2658
2305
        self.branch.lock_write()
2659
2306
        try:
2660
 
            self._control_files.lock_write()
2661
 
            return self
 
2307
            return self._control_files.lock_write()
2662
2308
        except:
2663
2309
            self.branch.unlock()
2664
2310
            raise
2665
2311
 
2666
2312
    def unlock(self):
2667
 
        # do non-implementation specific cleanup
2668
 
        self._cleanup()
2669
 
 
2670
2313
        # we share control files:
2671
2314
        if self._control_files._lock_count == 3:
2672
2315
            # _inventory_is_modified is always False during a read lock.
2673
2316
            if self._inventory_is_modified:
2674
2317
                self.flush()
2675
2318
            self._write_hashcache_if_dirty()
2676
 
 
 
2319
                    
2677
2320
        # reverse order of locking.
2678
2321
        try:
2679
2322
            return self._control_files.unlock()
2695
2338
    def _last_revision(self):
2696
2339
        """See Mutable.last_revision."""
2697
2340
        try:
2698
 
            return self._transport.get_bytes('last-revision')
 
2341
            return osutils.safe_revision_id(
 
2342
                        self._control_files.get('last-revision').read())
2699
2343
        except errors.NoSuchFile:
2700
 
            return _mod_revision.NULL_REVISION
 
2344
            return None
2701
2345
 
2702
2346
    def _change_last_revision(self, revision_id):
2703
2347
        """See WorkingTree._change_last_revision."""
2704
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2348
        if revision_id is None or revision_id == NULL_REVISION:
2705
2349
            try:
2706
 
                self._transport.delete('last-revision')
 
2350
                self._control_files._transport.delete('last-revision')
2707
2351
            except errors.NoSuchFile:
2708
2352
                pass
2709
2353
            return False
2710
2354
        else:
2711
 
            self._transport.put_bytes('last-revision', revision_id,
2712
 
                mode=self.bzrdir._get_file_mode())
 
2355
            self._control_files.put_bytes('last-revision', revision_id)
2713
2356
            return True
2714
2357
 
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
2358
    @needs_tree_write_lock
2720
2359
    def set_conflicts(self, conflicts):
2721
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2360
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2722
2361
                      CONFLICT_HEADER_1)
2723
2362
 
2724
2363
    @needs_tree_write_lock
2731
2370
    @needs_read_lock
2732
2371
    def conflicts(self):
2733
2372
        try:
2734
 
            confile = self._transport.get('conflicts')
 
2373
            confile = self._control_files.get('conflicts')
2735
2374
        except errors.NoSuchFile:
2736
2375
            return _mod_conflicts.ConflictList()
2737
2376
        try:
2738
 
            try:
2739
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2740
 
                    raise errors.ConflictFormatError()
2741
 
            except StopIteration:
 
2377
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2742
2378
                raise errors.ConflictFormatError()
2743
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2744
 
        finally:
2745
 
            confile.close()
 
2379
        except StopIteration:
 
2380
            raise errors.ConflictFormatError()
 
2381
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2746
2382
 
2747
2383
    def unlock(self):
2748
 
        # do non-implementation specific cleanup
2749
 
        self._cleanup()
2750
2384
        if self._control_files._lock_count == 1:
2751
2385
            # _inventory_is_modified is always False during a read lock.
2752
2386
            if self._inventory_is_modified:
2765
2399
            return path[:-len(suffix)]
2766
2400
 
2767
2401
 
 
2402
@deprecated_function(zero_eight)
 
2403
def is_control_file(filename):
 
2404
    """See WorkingTree.is_control_filename(filename)."""
 
2405
    ## FIXME: better check
 
2406
    filename = normpath(filename)
 
2407
    while filename != '':
 
2408
        head, tail = os.path.split(filename)
 
2409
        ## mutter('check %r for control file' % ((head, tail),))
 
2410
        if tail == '.bzr':
 
2411
            return True
 
2412
        if filename == head:
 
2413
            break
 
2414
        filename = head
 
2415
    return False
 
2416
 
 
2417
 
2768
2418
class WorkingTreeFormat(object):
2769
2419
    """An encapsulation of the initialization and open routines for a format.
2770
2420
 
2773
2423
     * a format string,
2774
2424
     * an open routine.
2775
2425
 
2776
 
    Formats are placed in an dict by their format string for reference
 
2426
    Formats are placed in an dict by their format string for reference 
2777
2427
    during workingtree opening. Its not required that these be instances, they
2778
 
    can be classes themselves with class methods - it simply depends on
 
2428
    can be classes themselves with class methods - it simply depends on 
2779
2429
    whether state is needed for a given format or not.
2780
2430
 
2781
2431
    Once a format is deprecated, just deprecate the initialize and open
2782
 
    methods on the format class. Do not deprecate the object, as the
 
2432
    methods on the format class. Do not deprecate the object, as the 
2783
2433
    object will be created every time regardless.
2784
2434
    """
2785
2435
 
2798
2448
        """Return the format for the working tree object in a_bzrdir."""
2799
2449
        try:
2800
2450
            transport = a_bzrdir.get_workingtree_transport(None)
2801
 
            format_string = transport.get_bytes("format")
 
2451
            format_string = transport.get("format").read()
2802
2452
            return klass._formats[format_string]
2803
2453
        except errors.NoSuchFile:
2804
2454
            raise errors.NoWorkingTree(base=transport.base)
2805
2455
        except KeyError:
2806
 
            raise errors.UnknownFormatError(format=format_string,
2807
 
                                            kind="working tree")
 
2456
            raise errors.UnknownFormatError(format=format_string)
2808
2457
 
2809
2458
    def __eq__(self, other):
2810
2459
        return self.__class__ is other.__class__
2829
2478
        """Is this format supported?
2830
2479
 
2831
2480
        Supported formats can be initialized and opened.
2832
 
        Unsupported formats may not support initialization or committing or
 
2481
        Unsupported formats may not support initialization or committing or 
2833
2482
        some other features depending on the reason for not being supported.
2834
2483
        """
2835
2484
        return True
2836
2485
 
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
2486
    @classmethod
2846
2487
    def register_format(klass, format):
2847
2488
        klass._formats[format.get_format_string()] = format
2852
2493
 
2853
2494
    @classmethod
2854
2495
    def unregister_format(klass, format):
 
2496
        assert klass._formats[format.get_format_string()] is format
2855
2497
        del klass._formats[format.get_format_string()]
2856
2498
 
2857
2499
 
2858
2500
class WorkingTreeFormat2(WorkingTreeFormat):
2859
 
    """The second working tree format.
 
2501
    """The second working tree format. 
2860
2502
 
2861
2503
    This format modified the hash cache from the format 1 hash cache.
2862
2504
    """
2867
2509
        """See WorkingTreeFormat.get_format_description()."""
2868
2510
        return "Working tree format 2"
2869
2511
 
2870
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2871
 
        """Workaround: create control files for a remote working tree.
2872
 
 
 
2512
    def stub_initialize_remote(self, control_files):
 
2513
        """As a special workaround create critical control files for a remote working tree
 
2514
        
2873
2515
        This ensures that it can later be updated and dealt with locally,
2874
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2516
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2875
2517
        no working tree.  (See bug #43064).
2876
2518
        """
2877
2519
        sio = StringIO()
2878
 
        inv = inventory.Inventory()
2879
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2520
        inv = Inventory()
 
2521
        xml5.serializer_v5.write_inventory(inv, sio)
2880
2522
        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):
 
2523
        control_files.put('inventory', sio)
 
2524
 
 
2525
        control_files.put_bytes('pending-merges', '')
 
2526
        
 
2527
 
 
2528
    def initialize(self, a_bzrdir, revision_id=None):
2886
2529
        """See WorkingTreeFormat.initialize()."""
2887
2530
        if not isinstance(a_bzrdir.transport, LocalTransport):
2888
2531
            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()
 
2532
        branch = a_bzrdir.open_branch()
 
2533
        if revision_id is not None:
 
2534
            revision_id = osutils.safe_revision_id(revision_id)
 
2535
            branch.lock_write()
 
2536
            try:
 
2537
                revision_history = branch.revision_history()
 
2538
                try:
 
2539
                    position = revision_history.index(revision_id)
 
2540
                except ValueError:
 
2541
                    raise errors.NoSuchRevision(branch, revision_id)
 
2542
                branch.set_revision_history(revision_history[:position + 1])
 
2543
            finally:
 
2544
                branch.unlock()
 
2545
        revision = branch.last_revision()
 
2546
        inv = Inventory()
2901
2547
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2902
2548
                         branch,
2903
2549
                         inv,
2904
2550
                         _internal=True,
2905
2551
                         _format=self,
2906
2552
                         _bzrdir=a_bzrdir)
2907
 
        basis_tree = branch.repository.revision_tree(revision_id)
 
2553
        basis_tree = branch.repository.revision_tree(revision)
2908
2554
        if basis_tree.inventory.root is not None:
2909
 
            wt.set_root_id(basis_tree.get_root_id())
 
2555
            wt.set_root_id(basis_tree.inventory.root.file_id)
2910
2556
        # 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)
 
2557
        wt.set_parent_trees([(revision, basis_tree)])
2916
2558
        transform.build_tree(basis_tree, wt)
2917
2559
        return wt
2918
2560
 
2948
2590
        - is new in bzr 0.8
2949
2591
        - uses a LockDir to guard access for writes.
2950
2592
    """
2951
 
 
 
2593
    
2952
2594
    upgrade_recommended = True
2953
2595
 
2954
2596
    def get_format_string(self):
2971
2613
 
2972
2614
    def _open_control_files(self, a_bzrdir):
2973
2615
        transport = a_bzrdir.get_workingtree_transport(None)
2974
 
        return LockableFiles(transport, self._lock_file_name,
 
2616
        return LockableFiles(transport, self._lock_file_name, 
2975
2617
                             self._lock_class)
2976
2618
 
2977
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2978
 
                   accelerator_tree=None, hardlink=False):
 
2619
    def initialize(self, a_bzrdir, revision_id=None):
2979
2620
        """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.
 
2621
        
 
2622
        revision_id allows creating a working tree at a different
 
2623
        revision than the branch is at.
2989
2624
        """
2990
2625
        if not isinstance(a_bzrdir.transport, LocalTransport):
2991
2626
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2993
2628
        control_files = self._open_control_files(a_bzrdir)
2994
2629
        control_files.create_lock()
2995
2630
        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
 
2631
        control_files.put_utf8('format', self.get_format_string())
 
2632
        branch = a_bzrdir.open_branch()
 
2633
        if revision_id is None:
 
2634
            revision_id = branch.last_revision()
3000
2635
        else:
3001
 
            branch = a_bzrdir.open_branch()
3002
 
        if revision_id is None:
3003
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2636
            revision_id = osutils.safe_revision_id(revision_id)
3004
2637
        # WorkingTree3 can handle an inventory which has a unique root id.
3005
2638
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3006
2639
        # those trees. And because there isn't a format bump inbetween, we
3019
2652
            basis_tree = branch.repository.revision_tree(revision_id)
3020
2653
            # only set an explicit root id if there is one to set.
3021
2654
            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:
 
2655
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2656
            if revision_id == NULL_REVISION:
3024
2657
                wt.set_parent_trees([])
3025
2658
            else:
3026
2659
                wt.set_parent_trees([(revision_id, basis_tree)])
3033
2666
        return wt
3034
2667
 
3035
2668
    def _initial_inventory(self):
3036
 
        return inventory.Inventory()
 
2669
        return Inventory()
3037
2670
 
3038
2671
    def __init__(self):
3039
2672
        super(WorkingTreeFormat3, self).__init__()
3054
2687
 
3055
2688
    def _open(self, a_bzrdir, control_files):
3056
2689
        """Open the tree itself.
3057
 
 
 
2690
        
3058
2691
        :param a_bzrdir: the dir for the tree.
3059
2692
        :param control_files: the control files for the tree.
3060
2693
        """
3068
2701
        return self.get_format_string()
3069
2702
 
3070
2703
 
3071
 
__default_format = WorkingTreeFormat6()
 
2704
__default_format = WorkingTreeFormat4()
3072
2705
WorkingTreeFormat.register_format(__default_format)
3073
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3074
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3075
2706
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3076
2707
WorkingTreeFormat.set_default_format(__default_format)
3077
2708
# formats which have no format string are not discoverable
3078
2709
# and not independently creatable, so are not registered.
3079
2710
_legacy_formats = [WorkingTreeFormat2(),
3080
2711
                   ]
 
2712
 
 
2713
 
 
2714
class WorkingTreeTestProviderAdapter(object):
 
2715
    """A tool to generate a suite testing multiple workingtree formats at once.
 
2716
 
 
2717
    This is done by copying the test once for each transport and injecting
 
2718
    the transport_server, transport_readonly_server, and workingtree_format
 
2719
    classes into each copy. Each copy is also given a new id() to make it
 
2720
    easy to identify.
 
2721
    """
 
2722
 
 
2723
    def __init__(self, transport_server, transport_readonly_server, formats):
 
2724
        self._transport_server = transport_server
 
2725
        self._transport_readonly_server = transport_readonly_server
 
2726
        self._formats = formats
 
2727
    
 
2728
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2729
        """Clone test for adaption."""
 
2730
        new_test = deepcopy(test)
 
2731
        new_test.transport_server = self._transport_server
 
2732
        new_test.transport_readonly_server = self._transport_readonly_server
 
2733
        new_test.bzrdir_format = bzrdir_format
 
2734
        new_test.workingtree_format = workingtree_format
 
2735
        def make_new_test_id():
 
2736
            new_id = "%s(%s)" % (test.id(), variation)
 
2737
            return lambda: new_id
 
2738
        new_test.id = make_new_test_id()
 
2739
        return new_test
 
2740
    
 
2741
    def adapt(self, test):
 
2742
        from bzrlib.tests import TestSuite
 
2743
        result = TestSuite()
 
2744
        for workingtree_format, bzrdir_format in self._formats:
 
2745
            new_test = self._clone_test(
 
2746
                test,
 
2747
                bzrdir_format,
 
2748
                workingtree_format, workingtree_format.__class__.__name__)
 
2749
            result.addTest(new_test)
 
2750
        return result