1
# Copyright (C) 2005 Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
17
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
 
 
19
from cStringIO import StringIO
 
 
21
from bzrlib.tree import Tree
 
 
24
class RevisionTree(Tree):
 
 
25
    """Tree viewing a previous revision.
 
 
27
    File text can be retrieved from the text store.
 
 
29
    TODO: Some kind of `__repr__` method, but a good one
 
 
30
           probably means knowing the branch and revision number,
 
 
31
           or at least passing a description to the constructor.
 
 
34
    def __init__(self, branch, inv, revision_id):
 
 
35
        # for compatability the 'branch' parameter has not been renamed to 
 
 
36
        # repository at this point. However, we should change RevisionTree's
 
 
37
        # construction to always be via Repository and not via direct 
 
 
38
        # construction - this will mean that we can change the constructor
 
 
39
        # with much less chance of breaking client code.
 
 
40
        self._repository = branch
 
 
41
        self._weave_store = branch.weave_store
 
 
43
        self._revision_id = revision_id
 
 
45
    def get_parent_ids(self):
 
 
46
        """See Tree.get_parent_ids.
 
 
48
        A RevisionTree's parents match the revision graph.
 
 
50
        if self._revision_id not in (None, 'null:'):
 
 
51
            parent_ids = self._repository.get_revision(
 
 
52
                self._revision_id).parent_ids
 
 
57
    def get_revision_id(self):
 
 
58
        """Return the revision id associated with this tree."""
 
 
59
        return self._revision_id
 
 
61
    def get_weave(self, file_id):
 
 
62
        return self._weave_store.get_weave(file_id,
 
 
63
                self._repository.get_transaction())
 
 
65
    def get_file_lines(self, file_id):
 
 
66
        ie = self._inventory[file_id]
 
 
67
        weave = self.get_weave(file_id)
 
 
68
        return weave.get_lines(ie.revision)
 
 
70
    def get_file_text(self, file_id):
 
 
71
        return ''.join(self.get_file_lines(file_id))
 
 
73
    def get_file(self, file_id):
 
 
74
        return StringIO(self.get_file_text(file_id))
 
 
76
    def annotate_iter(self, file_id):
 
 
77
        """See Tree.annotate_iter"""
 
 
78
        w = self.get_weave(file_id)
 
 
79
        return w.annotate_iter(self.inventory[file_id].revision)
 
 
81
    def get_file_size(self, file_id):
 
 
82
        return self._inventory[file_id].text_size
 
 
84
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
 
85
        ie = self._inventory[file_id]
 
 
90
    def get_file_mtime(self, file_id, path=None):
 
 
91
        ie = self._inventory[file_id]
 
 
92
        revision = self._repository.get_revision(ie.revision)
 
 
93
        return revision.timestamp
 
 
95
    def is_executable(self, file_id, path=None):
 
 
96
        ie = self._inventory[file_id]
 
 
99
        return self._inventory[file_id].executable
 
 
101
    def has_filename(self, filename):
 
 
102
        return bool(self.inventory.path2id(filename))
 
 
104
    def list_files(self, include_root=False):
 
 
105
        # The only files returned by this are those from the version
 
 
106
        entries = self.inventory.iter_entries()
 
 
107
        # skip the root for compatability with the current apis.
 
 
108
        if self.inventory.root is not None and not include_root:
 
 
109
            # skip the root for compatability with the current apis.
 
 
111
        for path, entry in entries:
 
 
112
            yield path, 'V', entry.kind, entry.file_id, entry
 
 
114
    def get_symlink_target(self, file_id):
 
 
115
        ie = self._inventory[file_id]
 
 
116
        return ie.symlink_target;
 
 
118
    def kind(self, file_id):
 
 
119
        return self._inventory[file_id].kind
 
 
121
    def _comparison_data(self, entry, path):
 
 
123
            return None, False, None
 
 
124
        return entry.kind, entry.executable, None
 
 
126
    def _file_size(self, entry, stat_value):
 
 
127
        assert entry.text_size is not None
 
 
128
        return entry.text_size
 
 
131
        self._repository.lock_read()
 
 
134
        self._repository.unlock()