/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-05-07 16:48:14 UTC
  • mto: This revision was merged to the branch mainline in revision 2485.
  • Revision ID: robertc@robertcollins.net-20070507164814-wpagonutf4b5cf8s
Move HACKING to docs/developers/HACKING and adjust Makefile to accomodate this.

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