/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/tree.py

Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tree.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Tree classes, representing directory at point in time.
 
18
"""
 
19
 
 
20
import os
 
21
from cStringIO import StringIO
 
22
from warnings import warn
 
23
 
 
24
import bzrlib
 
25
from bzrlib.errors import BzrError, BzrCheckError
 
26
from bzrlib import errors
 
27
from bzrlib.inventory import Inventory
 
28
from bzrlib.inter import InterObject
 
29
from bzrlib.osutils import fingerprint_file
 
30
import bzrlib.revision
 
31
from bzrlib.trace import mutter, note
 
32
 
 
33
 
 
34
class Tree(object):
 
35
    """Abstract file tree.
 
36
 
 
37
    There are several subclasses:
 
38
    
 
39
    * `WorkingTree` exists as files on disk editable by the user.
 
40
 
 
41
    * `RevisionTree` is a tree as recorded at some point in the past.
 
42
 
 
43
    Trees contain an `Inventory` object, and also know how to retrieve
 
44
    file texts mentioned in the inventory, either from a working
 
45
    directory or from a store.
 
46
 
 
47
    It is possible for trees to contain files that are not described
 
48
    in their inventory or vice versa; for this use `filenames()`.
 
49
 
 
50
    Trees can be compared, etc, regardless of whether they are working
 
51
    trees or versioned trees.
 
52
    """
 
53
    
 
54
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
55
        extra_trees=None, require_versioned=False):
 
56
        """Return a TreeDelta of the changes from other to this tree.
 
57
 
 
58
        :param other: A tree to compare with.
 
59
        :param specific_files: An optional list of file paths to restrict the
 
60
            comparison to. When mapping filenames to ids, all matches in all
 
61
            trees (including optional extra_trees) are used, and all children of
 
62
            matched directories are included.
 
63
        :param want_unchanged: An optional boolean requesting the inclusion of
 
64
            unchanged entries in the result.
 
65
        :param extra_trees: An optional list of additional trees to use when
 
66
            mapping the contents of specific_files (paths) to file_ids.
 
67
        :param require_versioned: An optional boolean (defaults to False). When
 
68
            supplied and True all the 'specific_files' must be versioned, or
 
69
            a PathsNotVersionedError will be thrown.
 
70
 
 
71
        The comparison will be performed by an InterTree object looked up on 
 
72
        self and other.
 
73
        """
 
74
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
75
        # may confuse people, because the class name of the returned object is
 
76
        # a synonym of the object referenced in the method name.
 
77
        return InterTree.get(other, self).compare(
 
78
            want_unchanged=want_unchanged,
 
79
            specific_files=specific_files,
 
80
            extra_trees=extra_trees,
 
81
            require_versioned=require_versioned,
 
82
            )
 
83
    
 
84
    def conflicts(self):
 
85
        """Get a list of the conflicts in the tree.
 
86
 
 
87
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
88
        """
 
89
        return []
 
90
 
 
91
    def get_parent_ids(self):
 
92
        """Get the parent ids for this tree. 
 
93
 
 
94
        :return: a list of parent ids. [] is returned to indicate
 
95
        a tree with no parents.
 
96
        :raises: BzrError if the parents are not known.
 
97
        """
 
98
        raise NotImplementedError(self.get_parent_ids)
 
99
    
 
100
    def has_filename(self, filename):
 
101
        """True if the tree has given filename."""
 
102
        raise NotImplementedError()
 
103
 
 
104
    def has_id(self, file_id):
 
105
        return self.inventory.has_id(file_id)
 
106
 
 
107
    __contains__ = has_id
 
108
 
 
109
    def has_or_had_id(self, file_id):
 
110
        if file_id == self.inventory.root.file_id:
 
111
            return True
 
112
        return self.inventory.has_id(file_id)
 
113
 
 
114
    def __iter__(self):
 
115
        return iter(self.inventory)
 
116
 
 
117
    def id2path(self, file_id):
 
118
        return self.inventory.id2path(file_id)
 
119
 
 
120
    def iter_entries_by_dir(self):
 
121
        """Walk the tree in 'by_dir' order.
 
122
 
 
123
        This will yield each entry in the tree as a (path, entry) tuple. The
 
124
        order that they are yielded is: the contents of a directory are 
 
125
        preceeded by the parent of a directory, and all the contents of a 
 
126
        directory are grouped together.
 
127
        """
 
128
        return self.inventory.iter_entries_by_dir()
 
129
 
 
130
    def kind(self, file_id):
 
131
        raise NotImplementedError("subclasses must implement kind")
 
132
 
 
133
    def _get_inventory(self):
 
134
        return self._inventory
 
135
    
 
136
    def get_file_by_path(self, path):
 
137
        return self.get_file(self._inventory.path2id(path))
 
138
 
 
139
    inventory = property(_get_inventory,
 
140
                         doc="Inventory of this Tree")
 
141
 
 
142
    def _check_retrieved(self, ie, f):
 
143
        if not __debug__:
 
144
            return  
 
145
        fp = fingerprint_file(f)
 
146
        f.seek(0)
 
147
        
 
148
        if ie.text_size != None:
 
149
            if ie.text_size != fp['size']:
 
150
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
151
                        ["inventory expects %d bytes" % ie.text_size,
 
152
                         "file is actually %d bytes" % fp['size'],
 
153
                         "store is probably damaged/corrupt"])
 
154
 
 
155
        if ie.text_sha1 != fp['sha1']:
 
156
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
157
                    ["inventory expects %s" % ie.text_sha1,
 
158
                     "file is actually %s" % fp['sha1'],
 
159
                     "store is probably damaged/corrupt"])
 
160
 
 
161
 
 
162
    def print_file(self, file_id):
 
163
        """Print file with id `file_id` to stdout."""
 
164
        import sys
 
165
        sys.stdout.write(self.get_file_text(file_id))
 
166
 
 
167
    def lock_read(self):
 
168
        pass
 
169
 
 
170
    def unknowns(self):
 
171
        """What files are present in this tree and unknown.
 
172
        
 
173
        :return: an iterator over the unknown files.
 
174
        """
 
175
        return iter([])
 
176
 
 
177
    def unlock(self):
 
178
        pass
 
179
 
 
180
    def filter_unversioned_files(self, paths):
 
181
        """Filter out paths that are not versioned.
 
182
 
 
183
        :return: set of paths.
 
184
        """
 
185
        # NB: we specifically *don't* call self.has_filename, because for
 
186
        # WorkingTrees that can indicate files that exist on disk but that 
 
187
        # are not versioned.
 
188
        pred = self.inventory.has_filename
 
189
        return set((p for p in paths if not pred(p)))
 
190
 
 
191
 
 
192
# for compatibility
 
193
from bzrlib.revisiontree import RevisionTree
 
194
 
 
195
 
 
196
class EmptyTree(Tree):
 
197
 
 
198
    def __init__(self):
 
199
        self._inventory = Inventory()
 
200
        warn('EmptyTree is deprecated as of bzr 0.9 please use '
 
201
            'repository.revision_tree instead.',
 
202
            DeprecationWarning, stacklevel=2)
 
203
 
 
204
    def get_parent_ids(self):
 
205
        return []
 
206
 
 
207
    def get_symlink_target(self, file_id):
 
208
        return None
 
209
 
 
210
    def has_filename(self, filename):
 
211
        return False
 
212
 
 
213
    def kind(self, file_id):
 
214
        assert self._inventory[file_id].kind == "root_directory"
 
215
        return "root_directory"
 
216
 
 
217
    def list_files(self):
 
218
        return iter([])
 
219
    
 
220
    def __contains__(self, file_id):
 
221
        return file_id in self._inventory
 
222
 
 
223
    def get_file_sha1(self, file_id, path=None):
 
224
        assert self._inventory[file_id].kind == "root_directory"
 
225
        return None
 
226
 
 
227
 
 
228
######################################################################
 
229
# diff
 
230
 
 
231
# TODO: Merge these two functions into a single one that can operate
 
232
# on either a whole tree or a set of files.
 
233
 
 
234
# TODO: Return the diff in order by filename, not by category or in
 
235
# random order.  Can probably be done by lock-stepping through the
 
236
# filenames from both trees.
 
237
 
 
238
 
 
239
def file_status(filename, old_tree, new_tree):
 
240
    """Return single-letter status, old and new names for a file.
 
241
 
 
242
    The complexity here is in deciding how to represent renames;
 
243
    many complex cases are possible.
 
244
    """
 
245
    old_inv = old_tree.inventory
 
246
    new_inv = new_tree.inventory
 
247
    new_id = new_inv.path2id(filename)
 
248
    old_id = old_inv.path2id(filename)
 
249
 
 
250
    if not new_id and not old_id:
 
251
        # easy: doesn't exist in either; not versioned at all
 
252
        if new_tree.is_ignored(filename):
 
253
            return 'I', None, None
 
254
        else:
 
255
            return '?', None, None
 
256
    elif new_id:
 
257
        # There is now a file of this name, great.
 
258
        pass
 
259
    else:
 
260
        # There is no longer a file of this name, but we can describe
 
261
        # what happened to the file that used to have
 
262
        # this name.  There are two possibilities: either it was
 
263
        # deleted entirely, or renamed.
 
264
        assert old_id
 
265
        if new_inv.has_id(old_id):
 
266
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
267
        else:
 
268
            return 'D', old_inv.id2path(old_id), None
 
269
 
 
270
    # if the file_id is new in this revision, it is added
 
271
    if new_id and not old_inv.has_id(new_id):
 
272
        return 'A'
 
273
 
 
274
    # if there used to be a file of this name, but that ID has now
 
275
    # disappeared, it is deleted
 
276
    if old_id and not new_inv.has_id(old_id):
 
277
        return 'D'
 
278
 
 
279
    return 'wtf?'
 
280
 
 
281
    
 
282
 
 
283
def find_renames(old_inv, new_inv):
 
284
    for file_id in old_inv:
 
285
        if file_id not in new_inv:
 
286
            continue
 
287
        old_name = old_inv.id2path(file_id)
 
288
        new_name = new_inv.id2path(file_id)
 
289
        if old_name != new_name:
 
290
            yield (old_name, new_name)
 
291
            
 
292
 
 
293
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
294
    """Find the ids corresponding to specified filenames.
 
295
    
 
296
    All matches in all trees will be used, and all children of matched
 
297
    directories will be used.
 
298
 
 
299
    :param filenames: The filenames to find file_ids for
 
300
    :param trees: The trees to find file_ids within
 
301
    :param require_versioned: if true, all specified filenames must occur in
 
302
    at least one tree.
 
303
    :return: a set of file ids for the specified filenames and their children.
 
304
    """
 
305
    if not filenames:
 
306
        return None
 
307
    specified_ids = _find_filename_ids_across_trees(filenames, trees, 
 
308
                                                    require_versioned)
 
309
    return _find_children_across_trees(specified_ids, trees)
 
310
 
 
311
 
 
312
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
 
313
    """Find the ids corresponding to specified filenames.
 
314
    
 
315
    All matches in all trees will be used.
 
316
 
 
317
    :param filenames: The filenames to find file_ids for
 
318
    :param trees: The trees to find file_ids within
 
319
    :param require_versioned: if true, all specified filenames must occur in
 
320
    at least one tree.
 
321
    :return: a set of file ids for the specified filenames
 
322
    """
 
323
    not_versioned = []
 
324
    interesting_ids = set()
 
325
    for tree_path in filenames:
 
326
        not_found = True
 
327
        for tree in trees:
 
328
            file_id = tree.inventory.path2id(tree_path)
 
329
            if file_id is not None:
 
330
                interesting_ids.add(file_id)
 
331
                not_found = False
 
332
        if not_found:
 
333
            not_versioned.append(tree_path)
 
334
    if len(not_versioned) > 0 and require_versioned:
 
335
        raise errors.PathsNotVersionedError(not_versioned)
 
336
    return interesting_ids
 
337
 
 
338
 
 
339
def _find_children_across_trees(specified_ids, trees):
 
340
    """Return a set including specified ids and their children
 
341
    
 
342
    All matches in all trees will be used.
 
343
 
 
344
    :param trees: The trees to find file_ids within
 
345
    :return: a set containing all specified ids and their children 
 
346
    """
 
347
    interesting_ids = set(specified_ids)
 
348
    pending = interesting_ids
 
349
    # now handle children of interesting ids
 
350
    # we loop so that we handle all children of each id in both trees
 
351
    while len(pending) > 0:
 
352
        new_pending = set()
 
353
        for file_id in pending:
 
354
            for tree in trees:
 
355
                if file_id not in tree:
 
356
                    continue
 
357
                entry = tree.inventory[file_id]
 
358
                for child in getattr(entry, 'children', {}).itervalues():
 
359
                    if child.file_id not in interesting_ids:
 
360
                        new_pending.add(child.file_id)
 
361
        interesting_ids.update(new_pending)
 
362
        pending = new_pending
 
363
    return interesting_ids
 
364
 
 
365
 
 
366
class InterTree(InterObject):
 
367
    """This class represents operations taking place between two Trees.
 
368
 
 
369
    Its instances have methods like 'compare' and contain references to the
 
370
    source and target trees these operations are to be carried out on.
 
371
 
 
372
    clients of bzrlib should not need to use InterTree directly, rather they
 
373
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
374
    will pass through to InterTree as appropriate.
 
375
    """
 
376
 
 
377
    _optimisers = set()
 
378
 
 
379
    def compare(self, want_unchanged=False, specific_files=None,
 
380
        extra_trees=None, require_versioned=False):
 
381
        """Return the changes from source to target.
 
382
 
 
383
        :return: A TreeDelta.
 
384
        :param specific_files: An optional list of file paths to restrict the
 
385
            comparison to. When mapping filenames to ids, all matches in all
 
386
            trees (including optional extra_trees) are used, and all children of
 
387
            matched directories are included.
 
388
        :param want_unchanged: An optional boolean requesting the inclusion of
 
389
            unchanged entries in the result.
 
390
        :param extra_trees: An optional list of additional trees to use when
 
391
            mapping the contents of specific_files (paths) to file_ids.
 
392
        :param require_versioned: An optional boolean (defaults to False). When
 
393
            supplied and True all the 'specific_files' must be versioned, or
 
394
            a PathsNotVersionedError will be thrown.
 
395
        """
 
396
        # imported later to avoid circular imports
 
397
        from bzrlib.delta import compare_trees
 
398
        return compare_trees(
 
399
            self.source,
 
400
            self.target,
 
401
            want_unchanged=want_unchanged,
 
402
            specific_files=specific_files,
 
403
            extra_trees=extra_trees,
 
404
            require_versioned=require_versioned,
 
405
            )