~bzr-pqm/bzr/bzr.dev

1852.7.1 by Robert Collins
Move RevisionTree out of 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
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
18
19
from cStringIO import StringIO
20
21
from bzrlib.tree import Tree
22
23
24
class RevisionTree(Tree):
25
    """Tree viewing a previous revision.
26
27
    File text can be retrieved from the text store.
28
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.
32
    """
33
    
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
42
        self._inventory = inv
43
        self._revision_id = revision_id
44
45
    def get_parent_ids(self):
46
        """See Tree.get_parent_ids.
47
48
        A RevisionTree's parents match the revision graph.
49
        """
50
        parent_ids = self._repository.get_revision(self._revision_id).parent_ids
51
        return parent_ids
52
        
53
    def get_revision_id(self):
54
        """Return the revision id associated with this tree."""
55
        return self._revision_id
56
57
    def get_weave(self, file_id):
58
        return self._weave_store.get_weave(file_id,
59
                self._repository.get_transaction())
60
61
    def get_file_lines(self, file_id):
62
        ie = self._inventory[file_id]
63
        weave = self.get_weave(file_id)
64
        return weave.get_lines(ie.revision)
65
66
    def get_file_text(self, file_id):
67
        return ''.join(self.get_file_lines(file_id))
68
69
    def get_file(self, file_id):
70
        return StringIO(self.get_file_text(file_id))
71
72
    def get_file_size(self, file_id):
73
        return self._inventory[file_id].text_size
74
75
    def get_file_sha1(self, file_id, path=None):
76
        ie = self._inventory[file_id]
77
        if ie.kind == "file":
78
            return ie.text_sha1
79
        return None
80
81
    def get_file_mtime(self, file_id, path=None):
82
        ie = self._inventory[file_id]
83
        revision = self._repository.get_revision(ie.revision)
84
        return revision.timestamp
85
86
    def is_executable(self, file_id, path=None):
87
        ie = self._inventory[file_id]
88
        if ie.kind != "file":
89
            return None 
90
        return self._inventory[file_id].executable
91
92
    def has_filename(self, filename):
93
        return bool(self.inventory.path2id(filename))
94
95
    def list_files(self):
96
        # The only files returned by this are those from the version
97
        entries = self.inventory.iter_entries()
98
        # skip the root for compatability with the current apis.
99
        entries.next()
100
        for path, entry in entries:
101
            yield path, 'V', entry.kind, entry.file_id, entry
102
103
    def get_symlink_target(self, file_id):
104
        ie = self._inventory[file_id]
105
        return ie.symlink_target;
106
107
    def kind(self, file_id):
108
        return self._inventory[file_id].kind
109
110
    def lock_read(self):
111
        self._repository.lock_read()
112
113
    def unlock(self):
114
        self._repository.unlock()
115
116