~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2010-10-07 06:08:01 UTC
  • mto: This revision was merged to the branch mainline in revision 5491.
  • Revision ID: v.ladeuil+lp@free.fr-20101007060801-wfdhizfhfmctl8qa
Fix some typos and propose a release planning.

Show diffs side-by-side

added added

removed removed

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