/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

Update the dirstate tests to lock and unlock properly.
Change the lock.WriteLock functions so that they open in 'rb+' mode instead
of automatically truncating the file.
test_dirstate.py now passes, but we need to figure out or locking mechanism for
WorkingTree4. (does it just lock at the same time as Tree.lock_write()?)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree4 format and implementation.
18
18
 
24
24
 
25
25
from cStringIO import StringIO
26
26
import os
27
 
import sys
28
27
 
29
28
from bzrlib.lazy_import import lazy_import
30
29
lazy_import(globals(), """
 
30
from bisect import bisect_left
 
31
import collections
 
32
from copy import deepcopy
31
33
import errno
 
34
import itertools
 
35
import operator
32
36
import stat
 
37
from time import time
 
38
import warnings
33
39
 
34
40
import bzrlib
35
41
from bzrlib import (
36
42
    bzrdir,
37
43
    cache_utf8,
38
 
    debug,
 
44
    conflicts as _mod_conflicts,
39
45
    dirstate,
40
46
    errors,
41
47
    generate_ids,
 
48
    globbing,
 
49
    hashcache,
 
50
    ignores,
 
51
    merge,
42
52
    osutils,
43
 
    revision as _mod_revision,
44
 
    revisiontree,
45
 
    trace,
 
53
    textui,
46
54
    transform,
47
 
    views,
 
55
    urlutils,
 
56
    xml5,
 
57
    xml6,
48
58
    )
49
59
import bzrlib.branch
 
60
from bzrlib.transport import get_transport
50
61
import bzrlib.ui
51
62
""")
52
63
 
 
64
from bzrlib import symbol_versioning
53
65
from bzrlib.decorators import needs_read_lock, needs_write_lock
54
 
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
55
 
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
 
66
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
 
67
from bzrlib.lockable_files import LockableFiles, TransportLock
 
68
from bzrlib.lockdir import LockDir
 
69
import bzrlib.mutabletree
56
70
from bzrlib.mutabletree import needs_tree_write_lock
57
71
from bzrlib.osutils import (
 
72
    compact_date,
58
73
    file_kind,
59
74
    isdir,
 
75
    normpath,
60
76
    pathjoin,
 
77
    rand_chars,
61
78
    realpath,
62
79
    safe_unicode,
 
80
    splitpath,
 
81
    supports_executable,
63
82
    )
64
 
from bzrlib.trace import mutter
 
83
from bzrlib.trace import mutter, note
65
84
from bzrlib.transport.local import LocalTransport
66
 
from bzrlib.tree import InterTree
 
85
from bzrlib.progress import DummyProgress, ProgressPhase
 
86
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
87
from bzrlib.rio import RioReader, rio_file, Stanza
 
88
from bzrlib.symbol_versioning import (deprecated_passed,
 
89
        deprecated_method,
 
90
        deprecated_function,
 
91
        DEPRECATED_PARAMETER,
 
92
        zero_eight,
 
93
        zero_eleven,
 
94
        zero_thirteen,
 
95
        )
67
96
from bzrlib.tree import Tree
68
97
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
69
98
 
70
99
 
71
 
class DirStateWorkingTree(WorkingTree3):
 
100
class WorkingTree4(WorkingTree3):
 
101
    """This is the Format 4 working tree.
 
102
 
 
103
    This differs from WorkingTree3 by:
 
104
     - having a consolidated internal dirstate.
 
105
     - not having a regular inventory attribute.
 
106
 
 
107
    This is new in bzr TODO FIXME SETMEBEFORE MERGE.
 
108
    """
 
109
 
72
110
    def __init__(self, basedir,
73
111
                 branch,
74
112
                 _control_files=None,
83
121
        """
84
122
        self._format = _format
85
123
        self.bzrdir = _bzrdir
 
124
        from bzrlib.hashcache import HashCache
 
125
        from bzrlib.trace import note, mutter
 
126
        assert isinstance(basedir, basestring), \
 
127
            "base directory %r is not a string" % basedir
86
128
        basedir = safe_unicode(basedir)
87
129
        mutter("opening working tree %r", basedir)
88
130
        self._branch = branch
 
131
        assert isinstance(self.branch, bzrlib.branch.Branch), \
 
132
            "branch %r is not a Branch" % self.branch
89
133
        self.basedir = realpath(basedir)
90
134
        # if branch is at our basedir and is a format 6 or less
91
135
        # assume all other formats have their own control files.
 
136
        assert isinstance(_control_files, LockableFiles), \
 
137
            "_control_files must be a LockableFiles, not %r" % _control_files
92
138
        self._control_files = _control_files
93
 
        self._transport = self._control_files._transport
 
139
        # update the whole cache up front and write to disk if anything changed;
 
140
        # in the future we might want to do this more selectively
 
141
        # two possible ways offer themselves : in self._unlock, write the cache
 
142
        # if needed, or, when the cache sees a change, append it to the hash
 
143
        # cache file, and have the parser take the most recent entry for a
 
144
        # given path only.
 
145
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
 
146
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
147
        hc.read()
 
148
        # is this scan needed ? it makes things kinda slow.
 
149
        #hc.scan()
 
150
 
 
151
        if hc.needs_write:
 
152
            mutter("write hc")
 
153
            hc.write()
 
154
 
94
155
        self._dirty = None
95
156
        #-------------
96
157
        # during a read or write lock these objects are set, and are
98
159
        self._dirstate = None
99
160
        self._inventory = None
100
161
        #-------------
101
 
        self._setup_directory_is_tree_reference()
102
 
        self._detect_case_handling()
103
 
        self._rules_searcher = None
104
 
        self.views = self._make_views()
105
 
        #--- allow tests to select the dirstate iter_changes implementation
106
 
        self._iter_changes = dirstate._process_entry
107
162
 
108
163
    @needs_tree_write_lock
109
164
    def _add(self, files, ids, kinds):
111
166
        state = self.current_dirstate()
112
167
        for f, file_id, kind in zip(files, ids, kinds):
113
168
            f = f.strip('/')
114
 
            if self.path2id(f):
115
 
                # special case tree root handling.
116
 
                if f == '' and self.path2id(f) == ROOT_ID:
117
 
                    state.set_path_id('', generate_ids.gen_file_id(f))
118
 
                continue
 
169
            assert '//' not in f
 
170
            assert '..' not in f
119
171
            if file_id is None:
120
172
                file_id = generate_ids.gen_file_id(f)
121
173
            # deliberately add the file with no cached stat or sha1
122
174
            # - on the first access it will be gathered, and we can
123
175
            # always change this once tests are all passing.
124
176
            state.add(f, file_id, kind, None, '')
125
 
        self._make_dirty(reset_inventory=True)
126
 
 
127
 
    def _make_dirty(self, reset_inventory):
128
 
        """Make the tree state dirty.
129
 
 
130
 
        :param reset_inventory: True if the cached inventory should be removed
131
 
            (presuming there is one).
132
 
        """
133
177
        self._dirty = True
134
 
        if reset_inventory and self._inventory is not None:
135
 
            self._inventory = None
136
 
 
137
 
    @needs_tree_write_lock
138
 
    def add_reference(self, sub_tree):
139
 
        # use standard implementation, which calls back to self._add
140
 
        #
141
 
        # So we don't store the reference_revision in the working dirstate,
142
 
        # it's just recorded at the moment of commit.
143
 
        self._add_reference(sub_tree)
144
 
 
145
 
    def break_lock(self):
146
 
        """Break a lock if one is present from another instance.
147
 
 
148
 
        Uses the ui factory to ask for confirmation if the lock may be from
149
 
        an active process.
150
 
 
151
 
        This will probe the repository for its lock as well.
152
 
        """
153
 
        # if the dirstate is locked by an active process, reject the break lock
154
 
        # call.
155
 
        try:
156
 
            if self._dirstate is None:
157
 
                clear = True
158
 
            else:
159
 
                clear = False
160
 
            state = self._current_dirstate()
161
 
            if state._lock_token is not None:
162
 
                # we already have it locked. sheese, cant break our own lock.
163
 
                raise errors.LockActive(self.basedir)
164
 
            else:
165
 
                try:
166
 
                    # try for a write lock - need permission to get one anyhow
167
 
                    # to break locks.
168
 
                    state.lock_write()
169
 
                except errors.LockContention:
170
 
                    # oslocks fail when a process is still live: fail.
171
 
                    # TODO: get the locked lockdir info and give to the user to
172
 
                    # assist in debugging.
173
 
                    raise errors.LockActive(self.basedir)
174
 
                else:
175
 
                    state.unlock()
176
 
        finally:
177
 
            if clear:
178
 
                self._dirstate = None
179
 
        self._control_files.break_lock()
180
 
        self.branch.break_lock()
181
 
 
182
 
    def _comparison_data(self, entry, path):
183
 
        kind, executable, stat_value = \
184
 
            WorkingTree3._comparison_data(self, entry, path)
185
 
        # it looks like a plain directory, but it's really a reference -- see
186
 
        # also kind()
187
 
        if (self._repo_supports_tree_reference and kind == 'directory'
188
 
            and entry is not None and entry.kind == 'tree-reference'):
189
 
            kind = 'tree-reference'
190
 
        return kind, executable, stat_value
191
 
 
192
 
    @needs_write_lock
193
 
    def commit(self, message=None, revprops=None, *args, **kwargs):
194
 
        # mark the tree as dirty post commit - commit
195
 
        # can change the current versioned list by doing deletes.
196
 
        result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
197
 
        self._make_dirty(reset_inventory=True)
198
 
        return result
199
178
 
200
179
    def current_dirstate(self):
201
 
        """Return the current dirstate object.
 
180
        """Return the current dirstate object. 
202
181
 
203
182
        This is not part of the tree interface and only exposed for ease of
204
183
        testing.
205
184
 
206
 
        :raises errors.NotWriteLocked: when not in a lock.
207
 
        """
208
 
        self._must_be_locked()
209
 
        return self._current_dirstate()
210
 
 
211
 
    def _current_dirstate(self):
212
 
        """Internal function that does not check lock status.
213
 
 
214
 
        This is needed for break_lock which also needs the dirstate.
215
 
        """
 
185
        :raises errors.NotWriteLocked: when not in a lock. 
 
186
            XXX: This should probably be errors.NotLocked.
 
187
        """
 
188
        if not self._control_files._lock_count:
 
189
            raise errors.ObjectNotLocked(self)
216
190
        if self._dirstate is not None:
217
191
            return self._dirstate
218
192
        local_path = self.bzrdir.get_workingtree_transport(None
219
193
            ).local_abspath('dirstate')
220
 
        self._dirstate = dirstate.DirState.on_file(local_path,
221
 
            self._sha1_provider())
 
194
        self._dirstate = dirstate.DirState.on_file(local_path)
222
195
        return self._dirstate
223
196
 
224
 
    def _sha1_provider(self):
225
 
        """A function that returns a SHA1Provider suitable for this tree.
226
 
 
227
 
        :return: None if content filtering is not supported by this tree.
228
 
          Otherwise, a SHA1Provider is returned that sha's the canonical
229
 
          form of files, i.e. after read filters are applied.
230
 
        """
231
 
        if self.supports_content_filtering():
232
 
            return ContentFilterAwareSHA1Provider(self)
233
 
        else:
234
 
            return None
235
 
 
236
197
    def filter_unversioned_files(self, paths):
237
 
        """Filter out paths that are versioned.
 
198
        """Filter out paths that are not versioned.
238
199
 
239
200
        :return: set of paths.
240
201
        """
249
210
            dirname, basename = os.path.split(path.encode('utf8'))
250
211
            _, _, _, path_is_versioned = state._get_block_entry_index(
251
212
                dirname, basename, 0)
252
 
            if not path_is_versioned:
 
213
            if path_is_versioned:
253
214
                result.add(path)
254
215
        return result
255
216
 
261
222
        self._inventory = None
262
223
        self._dirty = False
263
224
 
264
 
    @needs_tree_write_lock
265
 
    def _gather_kinds(self, files, kinds):
266
 
        """See MutableTree._gather_kinds."""
267
 
        for pos, f in enumerate(files):
268
 
            if kinds[pos] is None:
269
 
                kinds[pos] = self._kind(f)
270
 
 
271
225
    def _generate_inventory(self):
272
226
        """Create and set self.inventory from the dirstate object.
273
 
 
 
227
        
274
228
        This is relatively expensive: we have to walk the entire dirstate.
275
229
        Ideally we would not, and can deprecate this function.
276
230
        """
280
234
        state._read_dirblocks_if_needed()
281
235
        root_key, current_entry = self._get_entry(path='')
282
236
        current_id = root_key[2]
283
 
        if not (current_entry[0][0] == 'd'): # directory
284
 
            raise AssertionError(current_entry)
 
237
        assert current_entry[0][0] == 'd' # directory
285
238
        inv = Inventory(root_id=current_id)
286
239
        # Turn some things into local variables
287
240
        minikind_to_kind = dirstate.DirState._minikind_to_kind
294
247
        for block in state._dirblocks[1:]: # skip the root
295
248
            dirname = block[0]
296
249
            try:
297
 
                parent_ie = parent_ies[dirname]
 
250
                parent_ie = parent_ies[block[0]]
298
251
            except KeyError:
299
252
                # all the paths in this block are not versioned in this tree
300
253
                continue
310
263
                inv_entry = factory[kind](file_id, name_unicode,
311
264
                                          parent_ie.file_id)
312
265
                if kind == 'file':
313
 
                    # This is only needed on win32, where this is the only way
314
 
                    # we know the executable bit.
315
 
                    inv_entry.executable = executable
316
266
                    # not strictly needed: working tree
317
 
                    #inv_entry.text_size = size
318
 
                    #inv_entry.text_sha1 = sha1
 
267
                    #entry.executable = executable
 
268
                    #entry.text_size = size
 
269
                    #entry.text_sha1 = sha1
 
270
                    pass
319
271
                elif kind == 'directory':
320
272
                    # add this entry to the parent map.
321
273
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
322
 
                elif kind == 'tree-reference':
323
 
                    if not self._repo_supports_tree_reference:
324
 
                        raise errors.UnsupportedOperation(
325
 
                            self._generate_inventory,
326
 
                            self.branch.repository)
327
 
                    inv_entry.reference_revision = link_or_sha1 or None
328
 
                elif kind != 'symlink':
329
 
                    raise AssertionError("unknown kind %r" % kind)
330
274
                # These checks cost us around 40ms on a 55k entry tree
331
 
                if file_id in inv_byid:
332
 
                    raise AssertionError('file_id %s already in'
333
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
334
 
                if name_unicode in parent_ie.children:
335
 
                    raise AssertionError('name %r already in parent'
336
 
                        % (name_unicode,))
 
275
                assert file_id not in inv_byid
 
276
                assert name_unicode not in parent_ie.children
337
277
                inv_byid[file_id] = inv_entry
338
278
                parent_ie.children[name_unicode] = inv_entry
339
279
        self._inventory = inv
344
284
        If either file_id or path is supplied, it is used as the key to lookup.
345
285
        If both are supplied, the fastest lookup is used, and an error is
346
286
        raised if they do not both point at the same row.
347
 
 
 
287
        
348
288
        :param file_id: An optional unicode file_id to be looked up.
349
289
        :param path: An optional unicode path to be looked up.
350
290
        :return: The dirstate row tuple for path/file_id, or (None, None)
358
298
 
359
299
    def get_file_sha1(self, file_id, path=None, stat_value=None):
360
300
        # check file id is valid unconditionally.
361
 
        entry = self._get_entry(file_id=file_id, path=path)
362
 
        if entry[0] is None:
363
 
            raise errors.NoSuchId(self, file_id)
 
301
        key, details = self._get_entry(file_id=file_id, path=path)
 
302
        assert key is not None, 'what error should this raise'
 
303
        # TODO:
 
304
        # if row stat is valid, use cached sha1, else, get a new sha1.
364
305
        if path is None:
365
 
            path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
366
 
 
367
 
        file_abspath = self.abspath(path)
368
 
        state = self.current_dirstate()
369
 
        if stat_value is None:
370
 
            try:
371
 
                stat_value = os.lstat(file_abspath)
372
 
            except OSError, e:
373
 
                if e.errno == errno.ENOENT:
374
 
                    return None
375
 
                else:
376
 
                    raise
377
 
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
378
 
            stat_value=stat_value)
379
 
        if entry[1][0][0] == 'f':
380
 
            if link_or_sha1 is None:
381
 
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
382
 
                try:
383
 
                    sha1 = osutils.sha_file(file_obj)
384
 
                finally:
385
 
                    file_obj.close()
386
 
                self._observed_sha1(file_id, path, (sha1, statvalue))
387
 
                return sha1
388
 
            else:
389
 
                return link_or_sha1
390
 
        return None
 
306
            path = os.path.join(*key[0:2]).decode('utf8')
 
307
        return self._hashcache.get_sha1(path, stat_value)
391
308
 
392
309
    def _get_inventory(self):
393
310
        """Get the inventory for the tree. This is only valid within a lock."""
394
 
        if 'evil' in debug.debug_flags:
395
 
            trace.mutter_callsite(2,
396
 
                "accessing .inventory forces a size of tree translation.")
397
311
        if self._inventory is not None:
398
312
            return self._inventory
399
 
        self._must_be_locked()
400
313
        self._generate_inventory()
401
314
        return self._inventory
402
315
 
406
319
    @needs_read_lock
407
320
    def get_parent_ids(self):
408
321
        """See Tree.get_parent_ids.
409
 
 
 
322
        
410
323
        This implementation requests the ids list from the dirstate file.
411
324
        """
412
325
        return self.current_dirstate().get_parent_ids()
413
326
 
414
 
    def get_reference_revision(self, file_id, path=None):
415
 
        # referenced tree's revision is whatever's currently there
416
 
        return self.get_nested_tree(file_id, path).last_revision()
417
 
 
418
 
    def get_nested_tree(self, file_id, path=None):
419
 
        if path is None:
420
 
            path = self.id2path(file_id)
421
 
        # else: check file_id is at path?
422
 
        return WorkingTree.open(self.abspath(path))
423
 
 
424
327
    @needs_read_lock
425
328
    def get_root_id(self):
426
329
        """Return the id of this trees root"""
428
331
 
429
332
    def has_id(self, file_id):
430
333
        state = self.current_dirstate()
 
334
        file_id = osutils.safe_file_id(file_id)
431
335
        row, parents = self._get_entry(file_id=file_id)
432
336
        if row is None:
433
337
            return False
434
338
        return osutils.lexists(pathjoin(
435
339
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
436
340
 
437
 
    def has_or_had_id(self, file_id):
438
 
        state = self.current_dirstate()
439
 
        row, parents = self._get_entry(file_id=file_id)
440
 
        return row is not None
441
 
 
442
341
    @needs_read_lock
443
 
    def id2path(self, file_id):
444
 
        "Convert a file-id to a path."
445
 
        state = self.current_dirstate()
446
 
        entry = self._get_entry(file_id=file_id)
447
 
        if entry == (None, None):
448
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
449
 
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
450
 
        return path_utf8.decode('utf8')
451
 
 
452
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
453
 
        entry = self._get_entry(path=path)
454
 
        if entry == (None, None):
455
 
            return False # Missing entries are not executable
456
 
        return entry[1][0][3] # Executable?
457
 
 
458
 
    if not osutils.supports_executable():
459
 
        def is_executable(self, file_id, path=None):
460
 
            """Test if a file is executable or not.
461
 
 
462
 
            Note: The caller is expected to take a read-lock before calling this.
463
 
            """
464
 
            entry = self._get_entry(file_id=file_id, path=path)
465
 
            if entry == (None, None):
466
 
                return False
467
 
            return entry[1][0][3]
468
 
 
469
 
        _is_executable_from_path_and_stat = \
470
 
            _is_executable_from_path_and_stat_from_basis
471
 
    else:
472
 
        def is_executable(self, file_id, path=None):
473
 
            """Test if a file is executable or not.
474
 
 
475
 
            Note: The caller is expected to take a read-lock before calling this.
476
 
            """
477
 
            self._must_be_locked()
478
 
            if not path:
479
 
                path = self.id2path(file_id)
480
 
            mode = os.lstat(self.abspath(path)).st_mode
481
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
482
 
 
483
 
    def all_file_ids(self):
484
 
        """See Tree.iter_all_file_ids"""
485
 
        self._must_be_locked()
486
 
        result = set()
487
 
        for key, tree_details in self.current_dirstate()._iter_entries():
488
 
            if tree_details[0][0] in ('a', 'r'): # relocated
489
 
                continue
490
 
            result.add(key[2])
491
 
        return result
 
342
    def id2path(self, fileid):
 
343
        fileid = osutils.safe_file_id(fileid)
 
344
        inv = self._get_inventory()
 
345
        return inv.id2path(fileid)
 
346
        # TODO: jam 20070222 At present dirstate is very slow at id => path,
 
347
        #       while inventory is very fast at it. So for now, just generate
 
348
        #       the inventory and do the id => path check.
 
349
        #       In the future, we want to make dirstate better at id=>path
 
350
        #       checks so that we don't have to create the inventory.
 
351
        # state = self.current_dirstate()
 
352
        # key, tree_details = state._get_entry(0, fileid_utf8=fileid)
 
353
        # return os.path.join(*key[0:2]).decode('utf8')
492
354
 
493
355
    @needs_read_lock
494
356
    def __iter__(self):
507
369
                result.append(key[2])
508
370
        return iter(result)
509
371
 
510
 
    def iter_references(self):
511
 
        if not self._repo_supports_tree_reference:
512
 
            # When the repo doesn't support references, we will have nothing to
513
 
            # return
514
 
            return
515
 
        for key, tree_details in self.current_dirstate()._iter_entries():
516
 
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
517
 
                # not relevant to the working tree
518
 
                continue
519
 
            if not key[1]:
520
 
                # the root is not a reference.
521
 
                continue
522
 
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
523
 
            try:
524
 
                if self._kind(relpath) == 'tree-reference':
525
 
                    yield relpath, key[2]
526
 
            except errors.NoSuchFile:
527
 
                # path is missing on disk.
528
 
                continue
529
 
 
530
 
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
531
 
        """See MutableTree._observed_sha1."""
532
 
        state = self.current_dirstate()
533
 
        entry = self._get_entry(file_id=file_id, path=path)
534
 
        state._observed_sha1(entry, sha1, statvalue)
535
 
 
536
 
    def kind(self, file_id):
537
 
        """Return the kind of a file.
538
 
 
539
 
        This is always the actual kind that's on disk, regardless of what it
540
 
        was added as.
541
 
 
542
 
        Note: The caller is expected to take a read-lock before calling this.
543
 
        """
544
 
        relpath = self.id2path(file_id)
545
 
        if relpath is None:
546
 
            raise AssertionError(
547
 
                "path for id {%s} is None!" % file_id)
548
 
        return self._kind(relpath)
549
 
 
550
 
    def _kind(self, relpath):
551
 
        abspath = self.abspath(relpath)
552
 
        kind = file_kind(abspath)
553
 
        if (self._repo_supports_tree_reference and kind == 'directory'):
554
 
            entry = self._get_entry(path=relpath)
555
 
            if entry[1] is not None:
556
 
                if entry[1][0][0] == 't':
557
 
                    kind = 'tree-reference'
558
 
        return kind
559
 
 
560
372
    @needs_read_lock
561
373
    def _last_revision(self):
562
374
        """See Mutable.last_revision."""
564
376
        if parent_ids:
565
377
            return parent_ids[0]
566
378
        else:
567
 
            return _mod_revision.NULL_REVISION
568
 
 
569
 
    def lock_read(self):
570
 
        """See Branch.lock_read, and WorkingTree.unlock."""
571
 
        self.branch.lock_read()
572
 
        try:
573
 
            self._control_files.lock_read()
574
 
            try:
575
 
                state = self.current_dirstate()
576
 
                if not state._lock_token:
577
 
                    state.lock_read()
578
 
                # set our support for tree references from the repository in
579
 
                # use.
580
 
                self._repo_supports_tree_reference = getattr(
581
 
                    self.branch.repository._format, "supports_tree_reference",
582
 
                    False)
583
 
            except:
584
 
                self._control_files.unlock()
585
 
                raise
586
 
        except:
587
 
            self.branch.unlock()
588
 
            raise
589
 
 
590
 
    def _lock_self_write(self):
591
 
        """This should be called after the branch is locked."""
592
 
        try:
593
 
            self._control_files.lock_write()
594
 
            try:
595
 
                state = self.current_dirstate()
596
 
                if not state._lock_token:
597
 
                    state.lock_write()
598
 
                # set our support for tree references from the repository in
599
 
                # use.
600
 
                self._repo_supports_tree_reference = getattr(
601
 
                    self.branch.repository._format, "supports_tree_reference",
602
 
                    False)
603
 
            except:
604
 
                self._control_files.unlock()
605
 
                raise
606
 
        except:
607
 
            self.branch.unlock()
608
 
            raise
609
 
 
610
 
    def lock_tree_write(self):
611
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
612
 
        self.branch.lock_read()
613
 
        self._lock_self_write()
614
 
 
615
 
    def lock_write(self):
616
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
617
 
        self.branch.lock_write()
618
 
        self._lock_self_write()
 
379
            return None
619
380
 
620
381
    @needs_tree_write_lock
621
 
    def move(self, from_paths, to_dir, after=False):
 
382
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
622
383
        """See WorkingTree.move()."""
623
 
        result = []
624
384
        if not from_paths:
625
 
            return result
 
385
            return ()
 
386
 
626
387
        state = self.current_dirstate()
627
 
        if isinstance(from_paths, basestring):
628
 
            raise ValueError()
 
388
 
 
389
        # check for deprecated use of signature
 
390
        if to_dir is None:
 
391
            to_dir = kwargs.get('to_name', None)
 
392
            if to_dir is None:
 
393
                raise TypeError('You must supply a target directory')
 
394
            else:
 
395
                symbol_versioning.warn('The parameter to_name was deprecated'
 
396
                                       ' in version 0.13. Use to_dir instead',
 
397
                                       DeprecationWarning)
 
398
 
 
399
        assert not isinstance(from_paths, basestring)
629
400
        to_dir_utf8 = to_dir.encode('utf8')
630
401
        to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
631
 
        id_index = state._get_id_index()
632
402
        # check destination directory
633
403
        # get the details for it
634
404
        to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
635
405
            state._get_block_entry_index(to_entry_dirname, to_basename, 0)
636
406
        if not entry_present:
637
407
            raise errors.BzrMoveFailedError('', to_dir,
638
 
                errors.NotVersionedError(to_dir))
 
408
                errors.NotInWorkingDirectory(to_dir))
639
409
        to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
640
410
        # get a handle on the block itself.
641
411
        to_block_index = state._ensure_block(
653
423
        if self._inventory is not None:
654
424
            update_inventory = True
655
425
            inv = self.inventory
 
426
            to_dir_ie = inv[to_dir_id]
656
427
            to_dir_id = to_entry[0][2]
657
 
            to_dir_ie = inv[to_dir_id]
658
428
        else:
659
429
            update_inventory = False
660
430
 
661
 
        rollbacks = []
662
 
        def move_one(old_entry, from_path_utf8, minikind, executable,
663
 
                     fingerprint, packed_stat, size,
664
 
                     to_block, to_key, to_path_utf8):
665
 
            state._make_absent(old_entry)
666
 
            from_key = old_entry[0]
667
 
            rollbacks.append(
668
 
                lambda:state.update_minimal(from_key,
669
 
                    minikind,
670
 
                    executable=executable,
671
 
                    fingerprint=fingerprint,
672
 
                    packed_stat=packed_stat,
673
 
                    size=size,
674
 
                    path_utf8=from_path_utf8))
675
 
            state.update_minimal(to_key,
676
 
                    minikind,
677
 
                    executable=executable,
678
 
                    fingerprint=fingerprint,
679
 
                    packed_stat=packed_stat,
680
 
                    size=size,
681
 
                    path_utf8=to_path_utf8)
682
 
            added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
683
 
            new_entry = to_block[1][added_entry_index]
684
 
            rollbacks.append(lambda:state._make_absent(new_entry))
685
 
 
 
431
        # create rename entries and tuples
686
432
        for from_rel in from_paths:
687
433
            # from_rel is 'pathinroot/foo/bar'
688
 
            from_rel_utf8 = from_rel.encode('utf8')
689
 
            from_dirname, from_tail = osutils.split(from_rel)
690
 
            from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
 
434
            from_dirname, from_tail = os.path.split(from_rel)
 
435
            from_dirname = from_dirname.encode('utf8')
691
436
            from_entry = self._get_entry(path=from_rel)
692
437
            if from_entry == (None, None):
693
438
                raise errors.BzrMoveFailedError(from_rel,to_dir,
694
 
                    errors.NotVersionedError(path=from_rel))
 
439
                    errors.NotVersionedError(path=str(from_rel)))
695
440
 
696
441
            from_id = from_entry[0][2]
697
442
            to_rel = pathjoin(to_dir, from_tail)
698
 
            to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
699
443
            item_to_entry = self._get_entry(path=to_rel)
700
444
            if item_to_entry != (None, None):
701
445
                raise errors.BzrMoveFailedError(from_rel, to_rel,
723
467
            else:
724
468
                if from_missing: # implicitly just update our path mapping
725
469
                    move_file = False
726
 
                elif not after:
727
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
470
                else:
 
471
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
472
                        extra="(Use --after to update the Bazaar id)")
728
473
 
729
474
            rollbacks = []
730
475
            def rollback_rename():
731
476
                """A single rename has failed, roll it back."""
732
 
                # roll back everything, even if we encounter trouble doing one
733
 
                # of them.
734
 
                #
735
 
                # TODO: at least log the other exceptions rather than just
736
 
                # losing them mbp 20070307
737
 
                exc_info = None
 
477
                error = None
738
478
                for rollback in reversed(rollbacks):
739
479
                    try:
740
480
                        rollback()
741
481
                    except Exception, e:
742
 
                        exc_info = sys.exc_info()
743
 
                if exc_info:
744
 
                    raise exc_info[0], exc_info[1], exc_info[2]
 
482
                        import pdb;pdb.set_trace()
 
483
                        error = e
 
484
                if error:
 
485
                    raise error
745
486
 
746
487
            # perform the disk move first - its the most likely failure point.
747
 
            if move_file:
748
 
                from_rel_abs = self.abspath(from_rel)
749
 
                to_rel_abs = self.abspath(to_rel)
750
 
                try:
751
 
                    osutils.rename(from_rel_abs, to_rel_abs)
752
 
                except OSError, e:
753
 
                    raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
754
 
                rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
 
488
            from_rel_abs = self.abspath(from_rel)
 
489
            to_rel_abs = self.abspath(to_rel)
 
490
            try:
 
491
                osutils.rename(from_rel_abs, to_rel_abs)
 
492
            except OSError, e:
 
493
                raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
 
494
            rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
755
495
            try:
756
496
                # perform the rename in the inventory next if needed: its easy
757
497
                # to rollback
764
504
                        lambda: inv.rename(from_id, current_parent, from_tail))
765
505
                # finally do the rename in the dirstate, which is a little
766
506
                # tricky to rollback, but least likely to need it.
 
507
                basename = from_tail.encode('utf8')
767
508
                old_block_index, old_entry_index, dir_present, file_present = \
768
 
                    state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
 
509
                    state._get_block_entry_index(from_dirname, basename, 0)
769
510
                old_block = state._dirblocks[old_block_index][1]
770
 
                old_entry = old_block[old_entry_index]
771
 
                from_key, old_entry_details = old_entry
772
 
                cur_details = old_entry_details[0]
 
511
                old_entry_details = old_block[old_entry_index][1]
773
512
                # remove the old row
 
513
                from_key = old_block[old_entry_index][0]
774
514
                to_key = ((to_block[0],) + from_key[1:3])
775
 
                minikind = cur_details[0]
776
 
                move_one(old_entry, from_path_utf8=from_rel_utf8,
777
 
                         minikind=minikind,
778
 
                         executable=cur_details[3],
779
 
                         fingerprint=cur_details[1],
780
 
                         packed_stat=cur_details[4],
781
 
                         size=cur_details[2],
782
 
                         to_block=to_block,
783
 
                         to_key=to_key,
784
 
                         to_path_utf8=to_rel_utf8)
785
 
 
786
 
                if minikind == 'd':
787
 
                    def update_dirblock(from_dir, to_key, to_dir_utf8):
788
 
                        """Recursively update all entries in this dirblock."""
789
 
                        if from_dir == '':
790
 
                            raise AssertionError("renaming root not supported")
791
 
                        from_key = (from_dir, '')
792
 
                        from_block_idx, present = \
793
 
                            state._find_block_index_from_key(from_key)
794
 
                        if not present:
795
 
                            # This is the old record, if it isn't present, then
796
 
                            # there is theoretically nothing to update.
797
 
                            # (Unless it isn't present because of lazy loading,
798
 
                            # but we don't do that yet)
799
 
                            return
800
 
                        from_block = state._dirblocks[from_block_idx]
801
 
                        to_block_index, to_entry_index, _, _ = \
802
 
                            state._get_block_entry_index(to_key[0], to_key[1], 0)
803
 
                        to_block_index = state._ensure_block(
804
 
                            to_block_index, to_entry_index, to_dir_utf8)
805
 
                        to_block = state._dirblocks[to_block_index]
806
 
 
807
 
                        # Grab a copy since move_one may update the list.
808
 
                        for entry in from_block[1][:]:
809
 
                            if not (entry[0][0] == from_dir):
810
 
                                raise AssertionError()
811
 
                            cur_details = entry[1][0]
812
 
                            to_key = (to_dir_utf8, entry[0][1], entry[0][2])
813
 
                            from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
814
 
                            to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
815
 
                            minikind = cur_details[0]
816
 
                            if minikind in 'ar':
817
 
                                # Deleted children of a renamed directory
818
 
                                # Do not need to be updated.
819
 
                                # Children that have been renamed out of this
820
 
                                # directory should also not be updated
821
 
                                continue
822
 
                            move_one(entry, from_path_utf8=from_path_utf8,
823
 
                                     minikind=minikind,
824
 
                                     executable=cur_details[3],
825
 
                                     fingerprint=cur_details[1],
826
 
                                     packed_stat=cur_details[4],
827
 
                                     size=cur_details[2],
828
 
                                     to_block=to_block,
829
 
                                     to_key=to_key,
830
 
                                     to_path_utf8=to_path_utf8)
831
 
                            if minikind == 'd':
832
 
                                # We need to move all the children of this
833
 
                                # entry
834
 
                                update_dirblock(from_path_utf8, to_key,
835
 
                                                to_path_utf8)
836
 
                    update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
 
515
                state._make_absent(old_block[old_entry_index])
 
516
                minikind = old_entry_details[0][0]
 
517
                kind = dirstate.DirState._minikind_to_kind[minikind]
 
518
                rollbacks.append(
 
519
                    lambda:state.update_minimal(from_key,
 
520
                        kind,
 
521
                        num_present_parents=len(old_entry_details) - 1,
 
522
                        executable=old_entry_details[0][3],
 
523
                        fingerprint=old_entry_details[0][1],
 
524
                        packed_stat=old_entry_details[0][4],
 
525
                        size=old_entry_details[0][2],
 
526
                        id_index=state._get_id_index(),
 
527
                        path_utf8=from_rel.encode('utf8')))
 
528
                # create new row in current block
 
529
                state.update_minimal(to_key,
 
530
                        kind,
 
531
                        num_present_parents=len(old_entry_details) - 1,
 
532
                        executable=old_entry_details[0][3],
 
533
                        fingerprint=old_entry_details[0][1],
 
534
                        packed_stat=old_entry_details[0][4],
 
535
                        size=old_entry_details[0][2],
 
536
                        id_index=state._get_id_index(),
 
537
                        path_utf8=to_rel.encode('utf8'))
 
538
                added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
 
539
                new_entry = to_block[added_entry_index]
 
540
                rollbacks.append(lambda:state._make_absent(new_entry))
 
541
                if new_entry[1][0][0] == 'd':
 
542
                    import pdb;pdb.set_trace()
 
543
                    # if a directory, rename all the contents of child blocks
 
544
                    # adding rollbacks as each is inserted to remove them and
 
545
                    # restore the original
 
546
                    # TODO: large scale slice assignment.
 
547
                    # setup new list
 
548
                    # save old list region
 
549
                    # move up or down the old region
 
550
                    # add rollback to move the region back
 
551
                    # assign new list to new region
 
552
                    # done
837
553
            except:
838
554
                rollback_rename()
839
555
                raise
840
 
            result.append((from_rel, to_rel))
841
556
            state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
842
 
            self._make_dirty(reset_inventory=False)
843
 
 
844
 
        return result
845
 
 
846
 
    def _must_be_locked(self):
847
 
        if not self._control_files._lock_count:
848
 
            raise errors.ObjectNotLocked(self)
 
557
            self._dirty = True
 
558
 
 
559
        return #rename_tuples
849
560
 
850
561
    def _new_tree(self):
851
562
        """Initialize the state in this tree to be a new tree."""
854
565
    @needs_read_lock
855
566
    def path2id(self, path):
856
567
        """Return the id for path in this tree."""
857
 
        path = path.strip('/')
858
568
        entry = self._get_entry(path=path)
859
569
        if entry == (None, None):
860
570
            return None
862
572
 
863
573
    def paths2ids(self, paths, trees=[], require_versioned=True):
864
574
        """See Tree.paths2ids().
865
 
 
 
575
        
866
576
        This specialisation fast-paths the case where all the trees are in the
867
577
        dirstate.
868
578
        """
872
582
        for tree in trees:
873
583
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
874
584
                parents):
875
 
                return super(DirStateWorkingTree, self).paths2ids(paths,
876
 
                    trees, require_versioned)
 
585
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
877
586
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
878
587
        # -- make all paths utf8 --
879
588
        paths_utf8 = set()
883
592
        # -- paths is now a utf8 path set --
884
593
        # -- get the state object and prepare it.
885
594
        state = self.current_dirstate()
886
 
        if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
887
 
            and '' not in paths):
888
 
            paths2ids = self._paths2ids_using_bisect
889
 
        else:
890
 
            paths2ids = self._paths2ids_in_memory
891
 
        return paths2ids(paths, search_indexes,
892
 
                         require_versioned=require_versioned)
893
 
 
894
 
    def _paths2ids_in_memory(self, paths, search_indexes,
895
 
                             require_versioned=True):
896
 
        state = self.current_dirstate()
897
595
        state._read_dirblocks_if_needed()
898
596
        def _entries_for_path(path):
899
597
            """Return a list with all the entries that match path for all ids.
914
612
                entry_index += 1
915
613
            return result
916
614
        if require_versioned:
917
 
            # -- check all supplied paths are versioned in a search tree. --
 
615
            # -- check all supplied paths are versioned in all search trees. --
918
616
            all_versioned = True
919
617
            for path in paths:
920
618
                path_entries = _entries_for_path(path)
939
637
            if not all_versioned:
940
638
                raise errors.PathsNotVersionedError(paths)
941
639
        # -- remove redundancy in supplied paths to prevent over-scanning --
942
 
        search_paths = osutils.minimum_path_selection(paths)
943
 
        # sketch:
 
640
        search_paths = set()
 
641
        for path in paths:
 
642
            other_paths = paths.difference(set([path]))
 
643
            if not osutils.is_inside_any(other_paths, path):
 
644
                # this is a top level path, we must check it.
 
645
                search_paths.add(path)
 
646
        # sketch: 
944
647
        # for all search_indexs in each path at or under each element of
945
648
        # search_paths, if the detail is relocated: add the id, and add the
946
649
        # relocated path as one to search if its not searched already. If the
980
683
                block_index += 1
981
684
        return found_ids
982
685
 
983
 
    def _paths2ids_using_bisect(self, paths, search_indexes,
984
 
                                require_versioned=True):
985
 
        state = self.current_dirstate()
986
 
        found_ids = set()
987
 
 
988
 
        split_paths = sorted(osutils.split(p) for p in paths)
989
 
        found = state._bisect_recursive(split_paths)
990
 
 
991
 
        if require_versioned:
992
 
            found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
993
 
            for dir_name in split_paths:
994
 
                if dir_name not in found_dir_names:
995
 
                    raise errors.PathsNotVersionedError(paths)
996
 
 
997
 
        for dir_name_id, trees_info in found.iteritems():
998
 
            for index in search_indexes:
999
 
                if trees_info[index][0] not in ('r', 'a'):
1000
 
                    found_ids.add(dir_name_id[2])
1001
 
        return found_ids
1002
 
 
1003
686
    def read_working_inventory(self):
1004
687
        """Read the working inventory.
1005
 
 
 
688
        
1006
689
        This is a meaningless operation for dirstate, but we obey it anyhow.
1007
690
        """
1008
691
        return self.inventory
1013
696
 
1014
697
        WorkingTree4 supplies revision_trees for any basis tree.
1015
698
        """
 
699
        revision_id = osutils.safe_revision_id(revision_id)
1016
700
        dirstate = self.current_dirstate()
1017
701
        parent_ids = dirstate.get_parent_ids()
1018
702
        if revision_id not in parent_ids:
1025
709
    @needs_tree_write_lock
1026
710
    def set_last_revision(self, new_revision):
1027
711
        """Change the last revision in the working tree."""
 
712
        new_revision = osutils.safe_revision_id(new_revision)
1028
713
        parents = self.get_parent_ids()
1029
 
        if new_revision in (_mod_revision.NULL_REVISION, None):
1030
 
            if len(parents) >= 2:
1031
 
                raise AssertionError(
1032
 
                    "setting the last parent to none with a pending merge is "
1033
 
                    "unsupported.")
 
714
        if new_revision in (NULL_REVISION, None):
 
715
            assert len(parents) < 2, (
 
716
                "setting the last parent to none with a pending merge is "
 
717
                "unsupported.")
1034
718
            self.set_parent_ids([])
1035
719
        else:
1036
720
            self.set_parent_ids([new_revision] + parents[1:],
1039
723
    @needs_tree_write_lock
1040
724
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1041
725
        """Set the parent ids to revision_ids.
1042
 
 
 
726
        
1043
727
        See also set_parent_trees. This api will try to retrieve the tree data
1044
728
        for each element of revision_ids from the trees repository. If you have
1045
729
        tree data already available, it is more efficient to use
1049
733
        :param revision_ids: The revision_ids to set as the parent ids of this
1050
734
            working tree. Any of these may be ghosts.
1051
735
        """
 
736
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1052
737
        trees = []
1053
738
        for revision_id in revision_ids:
1054
739
            try:
1077
762
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1078
763
        real_trees = []
1079
764
        ghosts = []
1080
 
 
1081
 
        parent_ids = [rev_id for rev_id, tree in parents_list]
1082
 
        graph = self.branch.repository.get_graph()
1083
 
        heads = graph.heads(parent_ids)
1084
 
        accepted_revisions = set()
1085
 
 
1086
765
        # convert absent trees to the null tree, which we convert back to
1087
766
        # missing on access.
1088
767
        for rev_id, tree in parents_list:
1089
 
            if len(accepted_revisions) > 0:
1090
 
                # we always accept the first tree
1091
 
                if rev_id in accepted_revisions or rev_id not in heads:
1092
 
                    # We have already included either this tree, or its
1093
 
                    # descendent, so we skip it.
1094
 
                    continue
1095
 
            _mod_revision.check_not_reserved_id(rev_id)
 
768
            rev_id = osutils.safe_revision_id(rev_id)
1096
769
            if tree is not None:
1097
770
                real_trees.append((rev_id, tree))
1098
771
            else:
1099
772
                real_trees.append((rev_id,
1100
 
                    self.branch.repository.revision_tree(
1101
 
                        _mod_revision.NULL_REVISION)))
 
773
                    self.branch.repository.revision_tree(None)))
1102
774
                ghosts.append(rev_id)
1103
 
            accepted_revisions.add(rev_id)
1104
775
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1105
 
        self._make_dirty(reset_inventory=False)
 
776
        self._dirty = True
1106
777
 
1107
778
    def _set_root_id(self, file_id):
1108
779
        """See WorkingTree.set_root_id."""
1109
780
        state = self.current_dirstate()
1110
781
        state.set_path_id('', file_id)
1111
 
        if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1112
 
            self._make_dirty(reset_inventory=True)
1113
 
 
1114
 
    def _sha_from_stat(self, path, stat_result):
1115
 
        """Get a sha digest from the tree's stat cache.
1116
 
 
1117
 
        The default implementation assumes no stat cache is present.
1118
 
 
1119
 
        :param path: The path.
1120
 
        :param stat_result: The stat result being looked up.
1121
 
        """
1122
 
        return self.current_dirstate().sha1_from_stat(path, stat_result)
1123
 
 
1124
 
    @needs_read_lock
1125
 
    def supports_tree_reference(self):
1126
 
        return self._repo_supports_tree_reference
 
782
        self._dirty = state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED
1127
783
 
1128
784
    def unlock(self):
1129
785
        """Unlock in format 4 trees needs to write the entire dirstate."""
1130
 
        # do non-implementation specific cleanup
1131
 
        self._cleanup()
1132
 
 
1133
786
        if self._control_files._lock_count == 1:
 
787
            self._write_hashcache_if_dirty()
1134
788
            # eventually we should do signature checking during read locks for
1135
789
            # dirstate updates.
1136
790
            if self._control_files._lock_mode == 'w':
1137
791
                if self._dirty:
1138
792
                    self.flush()
1139
 
            if self._dirstate is not None:
1140
 
                # This is a no-op if there are no modifications.
1141
 
                self._dirstate.save()
1142
 
                self._dirstate.unlock()
1143
 
            # TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1144
 
            #       point. Instead, it could check if the header has been
1145
 
            #       modified when it is locked, and if not, it can hang on to
1146
 
            #       the data it has in memory.
1147
793
            self._dirstate = None
1148
794
            self._inventory = None
1149
795
        # reverse order of locking.
1166
812
            return
1167
813
        state = self.current_dirstate()
1168
814
        state._read_dirblocks_if_needed()
1169
 
        ids_to_unversion = set(file_ids)
 
815
        ids_to_unversion = set()
 
816
        for file_id in file_ids:
 
817
            ids_to_unversion.add(osutils.safe_file_id(file_id))
1170
818
        paths_to_unversion = set()
1171
819
        # sketch:
1172
820
        # check if the root is to be unversioned, if so, assert for now.
1178
826
                # I haven't written the code to unversion / yet - it should be
1179
827
                # supported.
1180
828
                raise errors.BzrError('Unversioning the / is not currently supported')
 
829
        details_length = len(state._dirblocks[0][1][0][1])
1181
830
        block_index = 0
1182
831
        while block_index < len(state._dirblocks):
1183
832
            # process one directory at a time.
1199
848
                # just forget the whole block.
1200
849
                entry_index = 0
1201
850
                while entry_index < len(block[1]):
1202
 
                    entry = block[1][entry_index]
1203
 
                    if entry[1][0][0] in 'ar':
1204
 
                        # don't remove absent or renamed entries
 
851
                    if not state._make_absent(block[1][entry_index]):
1205
852
                        entry_index += 1
1206
 
                    else:
1207
 
                        # Mark this file id as having been removed
1208
 
                        ids_to_unversion.discard(entry[0][2])
1209
 
                        if not state._make_absent(entry):
1210
 
                            # The block has not shrunk.
1211
 
                            entry_index += 1
1212
853
                # go to the next block. (At the moment we dont delete empty
1213
854
                # dirblocks)
1214
855
                block_index += 1
1223
864
                    entry_index += 1
1224
865
                    continue
1225
866
                if entry[1][0][0] == 'd':
1226
 
                    paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
 
867
                    paths_to_unversion.add(os.path.join(*entry[0][0:2]))
1227
868
                if not state._make_absent(entry):
1228
869
                    entry_index += 1
1229
870
                # we have unversioned this id
1231
872
            block_index += 1
1232
873
        if ids_to_unversion:
1233
874
            raise errors.NoSuchId(self, iter(ids_to_unversion).next())
1234
 
        self._make_dirty(reset_inventory=False)
 
875
        self._dirty = True
1235
876
        # have to change the legacy inventory too.
1236
877
        if self._inventory is not None:
1237
878
            for file_id in file_ids:
1238
879
                self._inventory.remove_recursive_id(file_id)
1239
880
 
1240
881
    @needs_tree_write_lock
1241
 
    def rename_one(self, from_rel, to_rel, after=False):
1242
 
        """See WorkingTree.rename_one"""
1243
 
        self.flush()
1244
 
        WorkingTree.rename_one(self, from_rel, to_rel, after)
1245
 
 
1246
 
    @needs_tree_write_lock
1247
 
    def apply_inventory_delta(self, changes):
1248
 
        """See MutableTree.apply_inventory_delta"""
1249
 
        state = self.current_dirstate()
1250
 
        state.update_by_delta(changes)
1251
 
        self._make_dirty(reset_inventory=True)
1252
 
 
1253
 
    def update_basis_by_delta(self, new_revid, delta):
1254
 
        """See MutableTree.update_basis_by_delta."""
1255
 
        if self.last_revision() == new_revid:
1256
 
            raise AssertionError()
1257
 
        self.current_dirstate().update_basis_by_delta(delta, new_revid)
1258
 
 
1259
 
    @needs_read_lock
1260
 
    def _validate(self):
1261
 
        self._dirstate._validate()
1262
 
 
1263
 
    @needs_tree_write_lock
1264
882
    def _write_inventory(self, inv):
1265
883
        """Write inventory as the current inventory."""
1266
 
        if self._dirty:
1267
 
            raise AssertionError("attempting to write an inventory when the "
1268
 
                "dirstate is dirty will lose pending changes")
1269
 
        had_inventory = self._inventory is not None
1270
 
        # Setting self._inventory = None forces the dirstate to regenerate the
1271
 
        # working inventory. We do this because self.inventory may be inv, or
1272
 
        # may have been modified, and either case would prevent a clean delta
1273
 
        # being created.
1274
 
        self._inventory = None
1275
 
        # generate a delta,
1276
 
        delta = inv._make_delta(self.inventory)
1277
 
        # and apply it.
1278
 
        self.apply_inventory_delta(delta)
1279
 
        if had_inventory:
1280
 
            self._inventory = inv
 
884
        assert not self._dirty, "attempting to write an inventory when the dirstate is dirty will cause data loss"
 
885
        self.current_dirstate().set_state_from_inventory(inv)
 
886
        self._dirty = True
1281
887
        self.flush()
1282
888
 
1283
889
 
1284
 
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1285
 
 
1286
 
    def __init__(self, tree):
1287
 
        self.tree = tree
1288
 
 
1289
 
    def sha1(self, abspath):
1290
 
        """See dirstate.SHA1Provider.sha1()."""
1291
 
        filters = self.tree._content_filter_stack(
1292
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1293
 
        return internal_size_sha_file_byname(abspath, filters)[1]
1294
 
 
1295
 
    def stat_and_sha1(self, abspath):
1296
 
        """See dirstate.SHA1Provider.stat_and_sha1()."""
1297
 
        filters = self.tree._content_filter_stack(
1298
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1299
 
        file_obj = file(abspath, 'rb', 65000)
1300
 
        try:
1301
 
            statvalue = os.fstat(file_obj.fileno())
1302
 
            if filters:
1303
 
                file_obj = filtered_input_file(file_obj, filters)
1304
 
            sha1 = osutils.size_sha_file(file_obj)[1]
1305
 
        finally:
1306
 
            file_obj.close()
1307
 
        return statvalue, sha1
1308
 
 
1309
 
 
1310
 
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1311
 
    """Dirstate working tree that supports content filtering.
1312
 
 
1313
 
    The dirstate holds the hash and size of the canonical form of the file, 
1314
 
    and most methods must return that.
1315
 
    """
1316
 
 
1317
 
    def _file_content_summary(self, path, stat_result):
1318
 
        # This is to support the somewhat obsolete path_content_summary method
1319
 
        # with content filtering: see
1320
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/415508>.
1321
 
        #
1322
 
        # If the dirstate cache is up to date and knows the hash and size,
1323
 
        # return that.
1324
 
        # Otherwise if there are no content filters, return the on-disk size
1325
 
        # and leave the hash blank.
1326
 
        # Otherwise, read and filter the on-disk file and use its size and
1327
 
        # hash.
1328
 
        #
1329
 
        # The dirstate doesn't store the size of the canonical form so we
1330
 
        # can't trust it for content-filtered trees.  We just return None.
1331
 
        dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1332
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
1333
 
        return ('file', None, executable, dirstate_sha1)
1334
 
 
1335
 
 
1336
 
class WorkingTree4(DirStateWorkingTree):
1337
 
    """This is the Format 4 working tree.
1338
 
 
1339
 
    This differs from WorkingTree3 by:
1340
 
     - Having a consolidated internal dirstate, stored in a
1341
 
       randomly-accessible sorted file on disk.
1342
 
     - Not having a regular inventory attribute.  One can be synthesized
1343
 
       on demand but this is expensive and should be avoided.
1344
 
 
1345
 
    This is new in bzr 0.15.
1346
 
    """
1347
 
 
1348
 
 
1349
 
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1350
 
    """This is the Format 5 working tree.
1351
 
 
1352
 
    This differs from WorkingTree4 by:
1353
 
     - Supporting content filtering.
1354
 
 
1355
 
    This is new in bzr 1.11.
1356
 
    """
1357
 
 
1358
 
 
1359
 
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1360
 
    """This is the Format 6 working tree.
1361
 
 
1362
 
    This differs from WorkingTree5 by:
1363
 
     - Supporting a current view that may mask the set of files in a tree
1364
 
       impacted by most user operations.
1365
 
 
1366
 
    This is new in bzr 1.14.
1367
 
    """
1368
 
 
1369
 
    def _make_views(self):
1370
 
        return views.PathBasedViews(self)
1371
 
 
1372
 
 
1373
 
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1374
 
 
1375
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1376
 
                   accelerator_tree=None, hardlink=False):
 
890
class WorkingTreeFormat4(WorkingTreeFormat3):
 
891
    """The first consolidated dirstate working tree format.
 
892
 
 
893
    This format:
 
894
        - exists within a metadir controlling .bzr
 
895
        - includes an explicit version marker for the workingtree control
 
896
          files, separate from the BzrDir format
 
897
        - modifies the hash cache format
 
898
        - is new in bzr TODO FIXME SETBEFOREMERGE
 
899
        - uses a LockDir to guard access to it.
 
900
    """
 
901
 
 
902
    def get_format_string(self):
 
903
        """See WorkingTreeFormat.get_format_string()."""
 
904
        return "Bazaar Working Tree format 4\n"
 
905
 
 
906
    def get_format_description(self):
 
907
        """See WorkingTreeFormat.get_format_description()."""
 
908
        return "Working tree format 4"
 
909
 
 
910
    def initialize(self, a_bzrdir, revision_id=None):
1377
911
        """See WorkingTreeFormat.initialize().
1378
912
 
1379
 
        :param revision_id: allows creating a working tree at a different
 
913
        revision_id allows creating a working tree at a different
1380
914
        revision than the branch is at.
1381
 
        :param accelerator_tree: A tree which can be used for retrieving file
1382
 
            contents more quickly than the revision tree, i.e. a workingtree.
1383
 
            The revision tree will be used for cases where accelerator_tree's
1384
 
            content is different.
1385
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1386
 
            where possible.
1387
 
 
1388
 
        These trees get an initial random root id, if their repository supports
1389
 
        rich root data, TREE_ROOT otherwise.
1390
915
        """
 
916
        revision_id = osutils.safe_revision_id(revision_id)
1391
917
        if not isinstance(a_bzrdir.transport, LocalTransport):
1392
918
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1393
919
        transport = a_bzrdir.get_workingtree_transport(self)
1394
920
        control_files = self._open_control_files(a_bzrdir)
1395
921
        control_files.create_lock()
1396
922
        control_files.lock_write()
1397
 
        transport.put_bytes('format', self.get_format_string(),
1398
 
            mode=a_bzrdir._get_file_mode())
1399
 
        if from_branch is not None:
1400
 
            branch = from_branch
1401
 
        else:
1402
 
            branch = a_bzrdir.open_branch()
 
923
        control_files.put_utf8('format', self.get_format_string())
 
924
        branch = a_bzrdir.open_branch()
1403
925
        if revision_id is None:
1404
926
            revision_id = branch.last_revision()
1405
927
        local_path = transport.local_abspath('dirstate')
1406
 
        # write out new dirstate (must exist when we create the tree)
1407
 
        state = dirstate.DirState.initialize(local_path)
1408
 
        state.unlock()
1409
 
        del state
1410
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
928
        dirstate.DirState.initialize(local_path)
 
929
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1411
930
                         branch,
1412
931
                         _format=self,
1413
932
                         _bzrdir=a_bzrdir,
1414
933
                         _control_files=control_files)
1415
934
        wt._new_tree()
1416
 
        wt.lock_tree_write()
 
935
        wt.lock_write()
1417
936
        try:
1418
 
            self._init_custom_control_files(wt)
1419
 
            if revision_id in (None, _mod_revision.NULL_REVISION):
1420
 
                if branch.repository.supports_rich_root():
1421
 
                    wt._set_root_id(generate_ids.gen_root_id())
1422
 
                else:
1423
 
                    wt._set_root_id(ROOT_ID)
1424
 
                wt.flush()
1425
 
            basis = None
1426
 
            # frequently, we will get here due to branching.  The accelerator
1427
 
            # tree will be the tree from the branch, so the desired basis
1428
 
            # tree will often be a parent of the accelerator tree.
1429
 
            if accelerator_tree is not None:
1430
 
                try:
1431
 
                    basis = accelerator_tree.revision_tree(revision_id)
1432
 
                except errors.NoSuchRevision:
1433
 
                    pass
1434
 
            if basis is None:
1435
 
                basis = branch.repository.revision_tree(revision_id)
1436
 
            if revision_id == _mod_revision.NULL_REVISION:
1437
 
                parents_list = []
1438
 
            else:
1439
 
                parents_list = [(revision_id, basis)]
 
937
            #wt.current_dirstate().set_path_id('', NEWROOT)
 
938
            wt.set_last_revision(revision_id)
 
939
            wt.flush()
 
940
            basis = wt.basis_tree()
1440
941
            basis.lock_read()
1441
 
            try:
1442
 
                wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1443
 
                wt.flush()
1444
 
                # if the basis has a root id we have to use that; otherwise we
1445
 
                # use a new random one
1446
 
                basis_root_id = basis.get_root_id()
1447
 
                if basis_root_id is not None:
1448
 
                    wt._set_root_id(basis_root_id)
1449
 
                    wt.flush()
1450
 
                if wt.supports_content_filtering():
1451
 
                    # The original tree may not have the same content filters
1452
 
                    # applied so we can't safely build the inventory delta from
1453
 
                    # the source tree.
1454
 
                    delta_from_tree = False
1455
 
                else:
1456
 
                    delta_from_tree = True
1457
 
                # delta_from_tree is safe even for DirStateRevisionTrees,
1458
 
                # because wt4.apply_inventory_delta does not mutate the input
1459
 
                # inventory entries.
1460
 
                transform.build_tree(basis, wt, accelerator_tree,
1461
 
                                     hardlink=hardlink,
1462
 
                                     delta_from_tree=delta_from_tree)
1463
 
            finally:
1464
 
                basis.unlock()
 
942
            transform.build_tree(basis, wt)
 
943
            basis.unlock()
1465
944
        finally:
1466
945
            control_files.unlock()
1467
946
            wt.unlock()
1468
947
        return wt
1469
948
 
1470
 
    def _init_custom_control_files(self, wt):
1471
 
        """Subclasses with custom control files should override this method.
1472
 
 
1473
 
        The working tree and control files are locked for writing when this
1474
 
        method is called.
1475
 
 
1476
 
        :param wt: the WorkingTree object
1477
 
        """
1478
949
 
1479
950
    def _open(self, a_bzrdir, control_files):
1480
951
        """Open the tree itself.
1482
953
        :param a_bzrdir: the dir for the tree.
1483
954
        :param control_files: the control files for the tree.
1484
955
        """
1485
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
956
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1486
957
                           branch=a_bzrdir.open_branch(),
1487
958
                           _format=self,
1488
959
                           _bzrdir=a_bzrdir,
1489
960
                           _control_files=control_files)
1490
961
 
1491
 
    def __get_matchingbzrdir(self):
1492
 
        return self._get_matchingbzrdir()
1493
 
 
1494
 
    def _get_matchingbzrdir(self):
1495
 
        """Overrideable method to get a bzrdir for testing."""
1496
 
        # please test against something that will let us do tree references
1497
 
        return bzrdir.format_registry.make_bzrdir(
1498
 
            'dirstate-with-subtree')
1499
 
 
1500
 
    _matchingbzrdir = property(__get_matchingbzrdir)
1501
 
 
1502
 
 
1503
 
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1504
 
    """The first consolidated dirstate working tree format.
1505
 
 
1506
 
    This format:
1507
 
        - exists within a metadir controlling .bzr
1508
 
        - includes an explicit version marker for the workingtree control
1509
 
          files, separate from the BzrDir format
1510
 
        - modifies the hash cache format
1511
 
        - is new in bzr 0.15
1512
 
        - uses a LockDir to guard access to it.
1513
 
    """
1514
 
 
1515
 
    upgrade_recommended = False
1516
 
 
1517
 
    _tree_class = WorkingTree4
1518
 
 
1519
 
    def get_format_string(self):
1520
 
        """See WorkingTreeFormat.get_format_string()."""
1521
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1522
 
 
1523
 
    def get_format_description(self):
1524
 
        """See WorkingTreeFormat.get_format_description()."""
1525
 
        return "Working tree format 4"
1526
 
 
1527
 
 
1528
 
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1529
 
    """WorkingTree format supporting content filtering.
1530
 
    """
1531
 
 
1532
 
    upgrade_recommended = False
1533
 
 
1534
 
    _tree_class = WorkingTree5
1535
 
 
1536
 
    def get_format_string(self):
1537
 
        """See WorkingTreeFormat.get_format_string()."""
1538
 
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1539
 
 
1540
 
    def get_format_description(self):
1541
 
        """See WorkingTreeFormat.get_format_description()."""
1542
 
        return "Working tree format 5"
1543
 
 
1544
 
    def supports_content_filtering(self):
1545
 
        return True
1546
 
 
1547
 
 
1548
 
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1549
 
    """WorkingTree format supporting views.
1550
 
    """
1551
 
 
1552
 
    upgrade_recommended = False
1553
 
 
1554
 
    _tree_class = WorkingTree6
1555
 
 
1556
 
    def get_format_string(self):
1557
 
        """See WorkingTreeFormat.get_format_string()."""
1558
 
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1559
 
 
1560
 
    def get_format_description(self):
1561
 
        """See WorkingTreeFormat.get_format_description()."""
1562
 
        return "Working tree format 6"
1563
 
 
1564
 
    def _init_custom_control_files(self, wt):
1565
 
        """Subclasses with custom control files should override this method."""
1566
 
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1567
 
 
1568
 
    def supports_content_filtering(self):
1569
 
        return True
1570
 
 
1571
 
    def supports_views(self):
1572
 
        return True
1573
 
 
1574
962
 
1575
963
class DirStateRevisionTree(Tree):
1576
 
    """A revision tree pulling the inventory from a dirstate.
1577
 
    
1578
 
    Note that this is one of the historical (ie revision) trees cached in the
1579
 
    dirstate for easy access, not the workingtree.
1580
 
    """
 
964
    """A revision tree pulling the inventory from a dirstate."""
1581
965
 
1582
966
    def __init__(self, dirstate, revision_id, repository):
1583
967
        self._dirstate = dirstate
1584
 
        self._revision_id = revision_id
 
968
        self._revision_id = osutils.safe_revision_id(revision_id)
1585
969
        self._repository = repository
1586
970
        self._inventory = None
1587
971
        self._locked = 0
1588
 
        self._dirstate_locked = False
1589
 
        self._repo_supports_tree_reference = getattr(
1590
 
            repository._format, "supports_tree_reference",
1591
 
            False)
1592
 
 
1593
 
    def __repr__(self):
1594
 
        return "<%s of %s in %s>" % \
1595
 
            (self.__class__.__name__, self._revision_id, self._dirstate)
1596
 
 
1597
 
    def annotate_iter(self, file_id,
1598
 
                      default_revision=_mod_revision.CURRENT_REVISION):
 
972
 
 
973
    def annotate_iter(self, file_id):
1599
974
        """See Tree.annotate_iter"""
1600
 
        text_key = (file_id, self.inventory[file_id].revision)
1601
 
        annotations = self._repository.texts.annotate(text_key)
1602
 
        return [(key[-1], line) for (key, line) in annotations]
 
975
        w = self._repository.weave_store.get_weave(file_id,
 
976
                           self._repository.get_transaction())
 
977
        return w.annotate_iter(self.inventory[file_id].revision)
1603
978
 
1604
 
    def _get_ancestors(self, default_revision):
1605
 
        return set(self._repository.get_ancestry(self._revision_id,
1606
 
                                                 topo_sorted=False))
1607
979
    def _comparison_data(self, entry, path):
1608
980
        """See Tree._comparison_data."""
1609
981
        if entry is None:
1623
995
        pred = self.has_filename
1624
996
        return set((p for p in paths if not pred(p)))
1625
997
 
1626
 
    def get_root_id(self):
1627
 
        return self.path2id('')
1628
 
 
1629
 
    def id2path(self, file_id):
1630
 
        "Convert a file-id to a path."
1631
 
        entry = self._get_entry(file_id=file_id)
1632
 
        if entry == (None, None):
1633
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1634
 
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1635
 
        return path_utf8.decode('utf8')
1636
 
 
1637
 
    def iter_references(self):
1638
 
        if not self._repo_supports_tree_reference:
1639
 
            # When the repo doesn't support references, we will have nothing to
1640
 
            # return
1641
 
            return iter([])
1642
 
        # Otherwise, fall back to the default implementation
1643
 
        return super(DirStateRevisionTree, self).iter_references()
1644
 
 
1645
 
    def _get_parent_index(self):
1646
 
        """Return the index in the dirstate referenced by this tree."""
1647
 
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1648
 
 
1649
998
    def _get_entry(self, file_id=None, path=None):
1650
999
        """Get the dirstate row for file_id or path.
1651
1000
 
1652
1001
        If either file_id or path is supplied, it is used as the key to lookup.
1653
1002
        If both are supplied, the fastest lookup is used, and an error is
1654
1003
        raised if they do not both point at the same row.
1655
 
 
 
1004
        
1656
1005
        :param file_id: An optional unicode file_id to be looked up.
1657
1006
        :param path: An optional unicode path to be looked up.
1658
1007
        :return: The dirstate row tuple for path/file_id, or (None, None)
1659
1008
        """
1660
1009
        if file_id is None and path is None:
1661
1010
            raise errors.BzrError('must supply file_id or path')
 
1011
        file_id = osutils.safe_file_id(file_id)
1662
1012
        if path is not None:
1663
1013
            path = path.encode('utf8')
1664
 
        parent_index = self._get_parent_index()
 
1014
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1665
1015
        return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
1666
1016
 
1667
1017
    def _generate_inventory(self):
1668
1018
        """Create and set self.inventory from the dirstate object.
1669
1019
 
1670
 
        (So this is only called the first time the inventory is requested for
1671
 
        this tree; it then remains in memory until it's out of date.)
1672
 
 
1673
1020
        This is relatively expensive: we have to walk the entire dirstate.
1674
 
        """
1675
 
        if not self._locked:
1676
 
            raise AssertionError(
1677
 
                'cannot generate inventory of an unlocked '
1678
 
                'dirstate revision tree')
 
1021
        Ideally we would not, and instead would """
 
1022
        assert self._locked, 'cannot generate inventory of an unlocked '\
 
1023
            'dirstate revision tree'
1679
1024
        # separate call for profiling - makes it clear where the costs are.
1680
1025
        self._dirstate._read_dirblocks_if_needed()
1681
 
        if self._revision_id not in self._dirstate.get_parent_ids():
1682
 
            raise AssertionError(
1683
 
                'parent %s has disappeared from %s' % (
1684
 
                self._revision_id, self._dirstate.get_parent_ids()))
 
1026
        assert self._revision_id in self._dirstate.get_parent_ids(), \
 
1027
            'parent %s has disappeared from %s' % (
 
1028
            self._revision_id, self._dirstate.get_parent_ids())
1685
1029
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1686
1030
        # This is identical now to the WorkingTree _generate_inventory except
1687
1031
        # for the tree index use.
1688
1032
        root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1689
1033
        current_id = root_key[2]
1690
 
        if current_entry[parent_index][0] != 'd':
1691
 
            raise AssertionError()
 
1034
        assert current_entry[parent_index][0] == 'd'
1692
1035
        inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1693
1036
        inv.root.revision = current_entry[parent_index][4]
1694
1037
        # Turn some things into local variables
1707
1050
                # all the paths in this block are not versioned in this tree
1708
1051
                continue
1709
1052
            for key, entry in block[1]:
1710
 
                minikind, fingerprint, size, executable, revid = entry[parent_index]
 
1053
                minikind, link_or_sha1, size, executable, revid = entry[parent_index]
1711
1054
                if minikind in ('a', 'r'): # absent, relocated
1712
1055
                    # not this tree
1713
1056
                    continue
1721
1064
                if kind == 'file':
1722
1065
                    inv_entry.executable = executable
1723
1066
                    inv_entry.text_size = size
1724
 
                    inv_entry.text_sha1 = fingerprint
 
1067
                    inv_entry.text_sha1 = link_or_sha1
1725
1068
                elif kind == 'directory':
1726
1069
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1727
1070
                elif kind == 'symlink':
1728
1071
                    inv_entry.executable = False
1729
 
                    inv_entry.text_size = None
1730
 
                    inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1731
 
                elif kind == 'tree-reference':
1732
 
                    inv_entry.reference_revision = fingerprint or None
 
1072
                    inv_entry.text_size = size
 
1073
                    inv_entry.symlink_target = utf8_decode(link_or_sha1)[0]
1733
1074
                else:
1734
 
                    raise AssertionError("cannot convert entry %r into an InventoryEntry"
1735
 
                            % entry)
 
1075
                    raise Exception, kind
1736
1076
                # These checks cost us around 40ms on a 55k entry tree
1737
 
                if file_id in inv_byid:
1738
 
                    raise AssertionError('file_id %s already in'
1739
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
1740
 
                if name_unicode in parent_ie.children:
1741
 
                    raise AssertionError('name %r already in parent'
1742
 
                        % (name_unicode,))
 
1077
                assert file_id not in inv_byid
 
1078
                assert name_unicode not in parent_ie.children
1743
1079
                inv_byid[file_id] = inv_entry
1744
1080
                parent_ie.children[name_unicode] = inv_entry
1745
1081
        self._inventory = inv
1746
1082
 
1747
 
    def get_file_mtime(self, file_id, path=None):
1748
 
        """Return the modification time for this record.
1749
 
 
1750
 
        We return the timestamp of the last-changed revision.
1751
 
        """
1752
 
        # Make sure the file exists
1753
 
        entry = self._get_entry(file_id, path=path)
1754
 
        if entry == (None, None): # do we raise?
1755
 
            return None
1756
 
        parent_index = self._get_parent_index()
1757
 
        last_changed_revision = entry[1][parent_index][4]
1758
 
        try:
1759
 
            rev = self._repository.get_revision(last_changed_revision)
1760
 
        except errors.NoSuchRevision:
1761
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
1762
 
        return rev.timestamp
1763
 
 
1764
1083
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1765
 
        entry = self._get_entry(file_id=file_id, path=path)
1766
 
        parent_index = self._get_parent_index()
1767
 
        parent_details = entry[1][parent_index]
1768
 
        if parent_details[0] == 'f':
1769
 
            return parent_details[1]
 
1084
        # TODO: if path is present, fast-path on that, as inventory
 
1085
        # might not be present
 
1086
        ie = self.inventory[file_id]
 
1087
        if ie.kind == "file":
 
1088
            return ie.text_sha1
1770
1089
        return None
1771
1090
 
1772
 
    def get_file(self, file_id, path=None):
 
1091
    def get_file(self, file_id):
1773
1092
        return StringIO(self.get_file_text(file_id))
1774
1093
 
 
1094
    def get_file_lines(self, file_id):
 
1095
        ie = self.inventory[file_id]
 
1096
        return self._repository.weave_store.get_weave(file_id,
 
1097
                self._repository.get_transaction()).get_lines(ie.revision)
 
1098
 
1775
1099
    def get_file_size(self, file_id):
1776
 
        """See Tree.get_file_size"""
1777
1100
        return self.inventory[file_id].text_size
1778
1101
 
1779
 
    def get_file_text(self, file_id, path=None):
1780
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1781
 
        return ''.join(content)
1782
 
 
1783
 
    def get_reference_revision(self, file_id, path=None):
1784
 
        return self.inventory[file_id].reference_revision
1785
 
 
1786
 
    def iter_files_bytes(self, desired_files):
1787
 
        """See Tree.iter_files_bytes.
1788
 
 
1789
 
        This version is implemented on top of Repository.iter_files_bytes"""
1790
 
        parent_index = self._get_parent_index()
1791
 
        repo_desired_files = []
1792
 
        for file_id, identifier in desired_files:
1793
 
            entry = self._get_entry(file_id)
1794
 
            if entry == (None, None):
1795
 
                raise errors.NoSuchId(self, file_id)
1796
 
            repo_desired_files.append((file_id, entry[1][parent_index][4],
1797
 
                                       identifier))
1798
 
        return self._repository.iter_files_bytes(repo_desired_files)
1799
 
 
1800
 
    def get_symlink_target(self, file_id):
1801
 
        entry = self._get_entry(file_id=file_id)
1802
 
        parent_index = self._get_parent_index()
1803
 
        if entry[1][parent_index][0] != 'l':
1804
 
            return None
1805
 
        else:
1806
 
            target = entry[1][parent_index][1]
1807
 
            target = target.decode('utf8')
1808
 
            return target
 
1102
    def get_file_text(self, file_id):
 
1103
        return ''.join(self.get_file_lines(file_id))
1809
1104
 
1810
1105
    def get_revision_id(self):
1811
1106
        """Return the revision id for this tree."""
1814
1109
    def _get_inventory(self):
1815
1110
        if self._inventory is not None:
1816
1111
            return self._inventory
1817
 
        self._must_be_locked()
1818
1112
        self._generate_inventory()
1819
1113
        return self._inventory
1820
1114
 
1829
1123
        return bool(self.path2id(filename))
1830
1124
 
1831
1125
    def kind(self, file_id):
1832
 
        entry = self._get_entry(file_id=file_id)[1]
1833
 
        if entry is None:
1834
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1835
 
        parent_index = self._get_parent_index()
1836
 
        return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1837
 
 
1838
 
    def stored_kind(self, file_id):
1839
 
        """See Tree.stored_kind"""
1840
 
        return self.kind(file_id)
1841
 
 
1842
 
    def path_content_summary(self, path):
1843
 
        """See Tree.path_content_summary."""
1844
 
        id = self.inventory.path2id(path)
1845
 
        if id is None:
1846
 
            return ('missing', None, None, None)
1847
 
        entry = self._inventory[id]
1848
 
        kind = entry.kind
1849
 
        if kind == 'file':
1850
 
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
1851
 
        elif kind == 'symlink':
1852
 
            return (kind, None, None, entry.symlink_target)
1853
 
        else:
1854
 
            return (kind, None, None, None)
 
1126
        return self.inventory[file_id].kind
1855
1127
 
1856
1128
    def is_executable(self, file_id, path=None):
1857
1129
        ie = self.inventory[file_id]
1859
1131
            return None
1860
1132
        return ie.executable
1861
1133
 
1862
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1134
    def list_files(self, include_root=False):
1863
1135
        # We use a standard implementation, because DirStateRevisionTree is
1864
1136
        # dealing with one of the parents of the current state
1865
1137
        inv = self._get_inventory()
1866
 
        if from_dir is None:
1867
 
            from_dir_id = None
1868
 
        else:
1869
 
            from_dir_id = inv.path2id(from_dir)
1870
 
            if from_dir_id is None:
1871
 
                # Directory not versioned
1872
 
                return
1873
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1874
 
        if inv.root is not None and not include_root and from_dir is None:
 
1138
        entries = inv.iter_entries()
 
1139
        if self.inventory.root is not None and not include_root:
1875
1140
            entries.next()
1876
1141
        for path, entry in entries:
1877
1142
            yield path, 'V', entry.kind, entry.file_id, entry
1880
1145
        """Lock the tree for a set of operations."""
1881
1146
        if not self._locked:
1882
1147
            self._repository.lock_read()
1883
 
            if self._dirstate._lock_token is None:
1884
 
                self._dirstate.lock_read()
1885
 
                self._dirstate_locked = True
1886
1148
        self._locked += 1
1887
1149
 
1888
 
    def _must_be_locked(self):
1889
 
        if not self._locked:
1890
 
            raise errors.ObjectNotLocked(self)
1891
 
 
1892
1150
    @needs_read_lock
1893
1151
    def path2id(self, path):
1894
1152
        """Return the id for path in this tree."""
1904
1162
        self._locked -=1
1905
1163
        if not self._locked:
1906
1164
            self._inventory = None
1907
 
            self._locked = 0
1908
 
            if self._dirstate_locked:
1909
 
                self._dirstate.unlock()
1910
 
                self._dirstate_locked = False
 
1165
            self._locked = False
1911
1166
            self._repository.unlock()
1912
1167
 
1913
 
    @needs_read_lock
1914
 
    def supports_tree_reference(self):
1915
 
        return self._repo_supports_tree_reference
1916
 
 
1917
1168
    def walkdirs(self, prefix=""):
1918
 
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1919
 
        # implementation based on an inventory.
1920
 
        # This should be cleaned up to use the much faster Dirstate code
1921
 
        # So for now, we just build up the parent inventory, and extract
1922
 
        # it the same way RevisionTree does.
 
1169
        # TODO: jam 20070215 This is the cheap way by cheating and using the
 
1170
        #       RevisionTree implementation.
 
1171
        #       This should be cleaned up to use the much faster Dirstate code
 
1172
        #       This is a little tricky, though, because the dirstate is
 
1173
        #       indexed by current path, not by parent path.
 
1174
        #       So for now, we just build up the parent inventory, and extract
 
1175
        #       it the same way RevisionTree does.
1923
1176
        _directory = 'directory'
1924
1177
        inv = self._get_inventory()
1925
1178
        top_id = inv.path2id(prefix)
1947
1200
            for dir in reversed(dirblock):
1948
1201
                if dir[2] == _directory:
1949
1202
                    pending.append((dir[0], dir[4]))
1950
 
 
1951
 
 
1952
 
class InterDirStateTree(InterTree):
1953
 
    """Fast path optimiser for changes_from with dirstate trees.
1954
 
 
1955
 
    This is used only when both trees are in the dirstate working file, and
1956
 
    the source is any parent within the dirstate, and the destination is
1957
 
    the current working tree of the same dirstate.
1958
 
    """
1959
 
    # this could be generalized to allow comparisons between any trees in the
1960
 
    # dirstate, and possibly between trees stored in different dirstates.
1961
 
 
1962
 
    def __init__(self, source, target):
1963
 
        super(InterDirStateTree, self).__init__(source, target)
1964
 
        if not InterDirStateTree.is_compatible(source, target):
1965
 
            raise Exception, "invalid source %r and target %r" % (source, target)
1966
 
 
1967
 
    @staticmethod
1968
 
    def make_source_parent_tree(source, target):
1969
 
        """Change the source tree into a parent of the target."""
1970
 
        revid = source.commit('record tree')
1971
 
        target.branch.repository.fetch(source.branch.repository, revid)
1972
 
        target.set_parent_ids([revid])
1973
 
        return target.basis_tree(), target
1974
 
 
1975
 
    @classmethod
1976
 
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1977
 
        result = klass.make_source_parent_tree(source, target)
1978
 
        result[1]._iter_changes = dirstate.ProcessEntryPython
1979
 
        return result
1980
 
 
1981
 
    @classmethod
1982
 
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
1983
 
                                                  target):
1984
 
        from bzrlib.tests.test__dirstate_helpers import \
1985
 
            compiled_dirstate_helpers_feature
1986
 
        test_case.requireFeature(compiled_dirstate_helpers_feature)
1987
 
        from bzrlib._dirstate_helpers_pyx import ProcessEntryC
1988
 
        result = klass.make_source_parent_tree(source, target)
1989
 
        result[1]._iter_changes = ProcessEntryC
1990
 
        return result
1991
 
 
1992
 
    _matching_from_tree_format = WorkingTreeFormat4()
1993
 
    _matching_to_tree_format = WorkingTreeFormat4()
1994
 
 
1995
 
    @classmethod
1996
 
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1997
 
        # This method shouldn't be called, because we have python and C
1998
 
        # specific flavours.
1999
 
        raise NotImplementedError
2000
 
 
2001
 
    def iter_changes(self, include_unchanged=False,
2002
 
                      specific_files=None, pb=None, extra_trees=[],
2003
 
                      require_versioned=True, want_unversioned=False):
2004
 
        """Return the changes from source to target.
2005
 
 
2006
 
        :return: An iterator that yields tuples. See InterTree.iter_changes
2007
 
            for details.
2008
 
        :param specific_files: An optional list of file paths to restrict the
2009
 
            comparison to. When mapping filenames to ids, all matches in all
2010
 
            trees (including optional extra_trees) are used, and all children of
2011
 
            matched directories are included.
2012
 
        :param include_unchanged: An optional boolean requesting the inclusion of
2013
 
            unchanged entries in the result.
2014
 
        :param extra_trees: An optional list of additional trees to use when
2015
 
            mapping the contents of specific_files (paths) to file_ids.
2016
 
        :param require_versioned: If True, all files in specific_files must be
2017
 
            versioned in one of source, target, extra_trees or
2018
 
            PathsNotVersionedError is raised.
2019
 
        :param want_unversioned: Should unversioned files be returned in the
2020
 
            output. An unversioned file is defined as one with (False, False)
2021
 
            for the versioned pair.
2022
 
        """
2023
 
        # TODO: handle extra trees in the dirstate.
2024
 
        if (extra_trees or specific_files == []):
2025
 
            # we can't fast-path these cases (yet)
2026
 
            return super(InterDirStateTree, self).iter_changes(
2027
 
                include_unchanged, specific_files, pb, extra_trees,
2028
 
                require_versioned, want_unversioned=want_unversioned)
2029
 
        parent_ids = self.target.get_parent_ids()
2030
 
        if not (self.source._revision_id in parent_ids
2031
 
                or self.source._revision_id == _mod_revision.NULL_REVISION):
2032
 
            raise AssertionError(
2033
 
                "revision {%s} is not stored in {%s}, but %s "
2034
 
                "can only be used for trees stored in the dirstate"
2035
 
                % (self.source._revision_id, self.target, self.iter_changes))
2036
 
        target_index = 0
2037
 
        if self.source._revision_id == _mod_revision.NULL_REVISION:
2038
 
            source_index = None
2039
 
            indices = (target_index,)
2040
 
        else:
2041
 
            if not (self.source._revision_id in parent_ids):
2042
 
                raise AssertionError(
2043
 
                    "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2044
 
                    self.source._revision_id, parent_ids))
2045
 
            source_index = 1 + parent_ids.index(self.source._revision_id)
2046
 
            indices = (source_index, target_index)
2047
 
        # -- make all specific_files utf8 --
2048
 
        if specific_files:
2049
 
            specific_files_utf8 = set()
2050
 
            for path in specific_files:
2051
 
                # Note, if there are many specific files, using cache_utf8
2052
 
                # would be good here.
2053
 
                specific_files_utf8.add(path.encode('utf8'))
2054
 
            specific_files = specific_files_utf8
2055
 
        else:
2056
 
            specific_files = set([''])
2057
 
        # -- specific_files is now a utf8 path set --
2058
 
 
2059
 
        # -- get the state object and prepare it.
2060
 
        state = self.target.current_dirstate()
2061
 
        state._read_dirblocks_if_needed()
2062
 
        if require_versioned:
2063
 
            # -- check all supplied paths are versioned in a search tree. --
2064
 
            not_versioned = []
2065
 
            for path in specific_files:
2066
 
                path_entries = state._entries_for_path(path)
2067
 
                if not path_entries:
2068
 
                    # this specified path is not present at all: error
2069
 
                    not_versioned.append(path)
2070
 
                    continue
2071
 
                found_versioned = False
2072
 
                # for each id at this path
2073
 
                for entry in path_entries:
2074
 
                    # for each tree.
2075
 
                    for index in indices:
2076
 
                        if entry[1][index][0] != 'a': # absent
2077
 
                            found_versioned = True
2078
 
                            # all good: found a versioned cell
2079
 
                            break
2080
 
                if not found_versioned:
2081
 
                    # none of the indexes was not 'absent' at all ids for this
2082
 
                    # path.
2083
 
                    not_versioned.append(path)
2084
 
            if len(not_versioned) > 0:
2085
 
                raise errors.PathsNotVersionedError(not_versioned)
2086
 
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
2087
 
        search_specific_files = osutils.minimum_path_selection(specific_files)
2088
 
 
2089
 
        use_filesystem_for_exec = (sys.platform != 'win32')
2090
 
        iter_changes = self.target._iter_changes(include_unchanged,
2091
 
            use_filesystem_for_exec, search_specific_files, state,
2092
 
            source_index, target_index, want_unversioned, self.target)
2093
 
        return iter_changes.iter_changes()
2094
 
 
2095
 
    @staticmethod
2096
 
    def is_compatible(source, target):
2097
 
        # the target must be a dirstate working tree
2098
 
        if not isinstance(target, DirStateWorkingTree):
2099
 
            return False
2100
 
        # the source must be a revtree or dirstate rev tree.
2101
 
        if not isinstance(source,
2102
 
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2103
 
            return False
2104
 
        # the source revid must be in the target dirstate
2105
 
        if not (source._revision_id == _mod_revision.NULL_REVISION or
2106
 
            source._revision_id in target.get_parent_ids()):
2107
 
            # TODO: what about ghosts? it may well need to
2108
 
            # check for them explicitly.
2109
 
            return False
2110
 
        return True
2111
 
 
2112
 
InterTree.register_optimiser(InterDirStateTree)
2113
 
 
2114
 
 
2115
 
class Converter3to4(object):
2116
 
    """Perform an in-place upgrade of format 3 to format 4 trees."""
2117
 
 
2118
 
    def __init__(self):
2119
 
        self.target_format = WorkingTreeFormat4()
2120
 
 
2121
 
    def convert(self, tree):
2122
 
        # lock the control files not the tree, so that we dont get tree
2123
 
        # on-unlock behaviours, and so that noone else diddles with the
2124
 
        # tree during upgrade.
2125
 
        tree._control_files.lock_write()
2126
 
        try:
2127
 
            tree.read_working_inventory()
2128
 
            self.create_dirstate_data(tree)
2129
 
            self.update_format(tree)
2130
 
            self.remove_xml_files(tree)
2131
 
        finally:
2132
 
            tree._control_files.unlock()
2133
 
 
2134
 
    def create_dirstate_data(self, tree):
2135
 
        """Create the dirstate based data for tree."""
2136
 
        local_path = tree.bzrdir.get_workingtree_transport(None
2137
 
            ).local_abspath('dirstate')
2138
 
        state = dirstate.DirState.from_tree(tree, local_path)
2139
 
        state.save()
2140
 
        state.unlock()
2141
 
 
2142
 
    def remove_xml_files(self, tree):
2143
 
        """Remove the oldformat 3 data."""
2144
 
        transport = tree.bzrdir.get_workingtree_transport(None)
2145
 
        for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2146
 
            'pending-merges', 'stat-cache']:
2147
 
            try:
2148
 
                transport.delete(path)
2149
 
            except errors.NoSuchFile:
2150
 
                # some files are optional - just deal.
2151
 
                pass
2152
 
 
2153
 
    def update_format(self, tree):
2154
 
        """Change the format marker."""
2155
 
        tree._transport.put_bytes('format',
2156
 
            self.target_format.get_format_string(),
2157
 
            mode=tree.bzrdir._get_file_mode())
2158
 
 
2159
 
 
2160
 
class Converter4to5(object):
2161
 
    """Perform an in-place upgrade of format 4 to format 5 trees."""
2162
 
 
2163
 
    def __init__(self):
2164
 
        self.target_format = WorkingTreeFormat5()
2165
 
 
2166
 
    def convert(self, tree):
2167
 
        # lock the control files not the tree, so that we don't get tree
2168
 
        # on-unlock behaviours, and so that no-one else diddles with the
2169
 
        # tree during upgrade.
2170
 
        tree._control_files.lock_write()
2171
 
        try:
2172
 
            self.update_format(tree)
2173
 
        finally:
2174
 
            tree._control_files.unlock()
2175
 
 
2176
 
    def update_format(self, tree):
2177
 
        """Change the format marker."""
2178
 
        tree._transport.put_bytes('format',
2179
 
            self.target_format.get_format_string(),
2180
 
            mode=tree.bzrdir._get_file_mode())
2181
 
 
2182
 
 
2183
 
class Converter4or5to6(object):
2184
 
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2185
 
 
2186
 
    def __init__(self):
2187
 
        self.target_format = WorkingTreeFormat6()
2188
 
 
2189
 
    def convert(self, tree):
2190
 
        # lock the control files not the tree, so that we don't get tree
2191
 
        # on-unlock behaviours, and so that no-one else diddles with the
2192
 
        # tree during upgrade.
2193
 
        tree._control_files.lock_write()
2194
 
        try:
2195
 
            self.init_custom_control_files(tree)
2196
 
            self.update_format(tree)
2197
 
        finally:
2198
 
            tree._control_files.unlock()
2199
 
 
2200
 
    def init_custom_control_files(self, tree):
2201
 
        """Initialize custom control files."""
2202
 
        tree._transport.put_bytes('views', '',
2203
 
            mode=tree.bzrdir._get_file_mode())
2204
 
 
2205
 
    def update_format(self, tree):
2206
 
        """Change the format marker."""
2207
 
        tree._transport.put_bytes('format',
2208
 
            self.target_format.get_format_string(),
2209
 
            mode=tree.bzrdir._get_file_mode())