~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

[merge] bzr.dev 2294

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2007 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 import (
 
22
    osutils,
 
23
    revision,
 
24
    )
 
25
from bzrlib.tree import Tree
 
26
 
 
27
 
 
28
class RevisionTree(Tree):
 
29
    """Tree viewing a previous revision.
 
30
 
 
31
    File text can be retrieved from the text store.
 
32
 
 
33
    TODO: Some kind of `__repr__` method, but a good one
 
34
           probably means knowing the branch and revision number,
 
35
           or at least passing a description to the constructor.
 
36
    """
 
37
    
 
38
    def __init__(self, branch, inv, revision_id):
 
39
        # for compatability the 'branch' parameter has not been renamed to 
 
40
        # repository at this point. However, we should change RevisionTree's
 
41
        # construction to always be via Repository and not via direct 
 
42
        # construction - this will mean that we can change the constructor
 
43
        # with much less chance of breaking client code.
 
44
        self._repository = branch
 
45
        self._weave_store = branch.weave_store
 
46
        self._inventory = inv
 
47
        self._revision_id = osutils.safe_revision_id(revision_id)
 
48
 
 
49
    def get_parent_ids(self):
 
50
        """See Tree.get_parent_ids.
 
51
 
 
52
        A RevisionTree's parents match the revision graph.
 
53
        """
 
54
        if self._revision_id in (None, revision.NULL_REVISION):
 
55
            parent_ids = []
 
56
        else:
 
57
            parent_ids = self._repository.get_revision(
 
58
                self._revision_id).parent_ids
 
59
        return parent_ids
 
60
        
 
61
    def get_revision_id(self):
 
62
        """Return the revision id associated with this tree."""
 
63
        return self._revision_id
 
64
 
 
65
    def get_weave(self, file_id):
 
66
        return self._weave_store.get_weave(file_id,
 
67
                self._repository.get_transaction())
 
68
 
 
69
    def get_file_lines(self, file_id):
 
70
        ie = self._inventory[file_id]
 
71
        weave = self.get_weave(file_id)
 
72
        return weave.get_lines(ie.revision)
 
73
 
 
74
    def get_file_text(self, file_id):
 
75
        return ''.join(self.get_file_lines(file_id))
 
76
 
 
77
    def get_file(self, file_id):
 
78
        return StringIO(self.get_file_text(file_id))
 
79
 
 
80
    def annotate_iter(self, file_id):
 
81
        """See Tree.annotate_iter"""
 
82
        w = self.get_weave(file_id)
 
83
        return w.annotate_iter(self.inventory[file_id].revision)
 
84
 
 
85
    def get_file_size(self, file_id):
 
86
        return self._inventory[file_id].text_size
 
87
 
 
88
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
89
        ie = self._inventory[file_id]
 
90
        if ie.kind == "file":
 
91
            return ie.text_sha1
 
92
        return None
 
93
 
 
94
    def get_file_mtime(self, file_id, path=None):
 
95
        ie = self._inventory[file_id]
 
96
        revision = self._repository.get_revision(ie.revision)
 
97
        return revision.timestamp
 
98
 
 
99
    def is_executable(self, file_id, path=None):
 
100
        ie = self._inventory[file_id]
 
101
        if ie.kind != "file":
 
102
            return None 
 
103
        return ie.executable
 
104
 
 
105
    def has_filename(self, filename):
 
106
        return bool(self.inventory.path2id(filename))
 
107
 
 
108
    def list_files(self, include_root=False):
 
109
        # The only files returned by this are those from the version
 
110
        entries = self.inventory.iter_entries()
 
111
        # skip the root for compatability with the current apis.
 
112
        if self.inventory.root is not None and not include_root:
 
113
            # skip the root for compatability with the current apis.
 
114
            entries.next()
 
115
        for path, entry in entries:
 
116
            yield path, 'V', entry.kind, entry.file_id, entry
 
117
 
 
118
    def get_symlink_target(self, file_id):
 
119
        ie = self._inventory[file_id]
 
120
        return ie.symlink_target;
 
121
 
 
122
    def kind(self, file_id):
 
123
        return self._inventory[file_id].kind
 
124
 
 
125
    def _comparison_data(self, entry, path):
 
126
        if entry is None:
 
127
            return None, False, None
 
128
        return entry.kind, entry.executable, None
 
129
 
 
130
    def _file_size(self, entry, stat_value):
 
131
        assert entry.text_size is not None
 
132
        return entry.text_size
 
133
 
 
134
    def lock_read(self):
 
135
        self._repository.lock_read()
 
136
 
 
137
    def unlock(self):
 
138
        self._repository.unlock()
 
139
 
 
140
    def walkdirs(self, prefix=""):
 
141
        _directory = 'directory'
 
142
        inv = self.inventory
 
143
        top_id = inv.path2id(prefix)
 
144
        if top_id is None:
 
145
            pending = []
 
146
        else:
 
147
            pending = [(prefix, '', _directory, None, top_id, None)]
 
148
        while pending:
 
149
            dirblock = []
 
150
            currentdir = pending.pop()
 
151
            # 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
 
152
            if currentdir[0]:
 
153
                relroot = currentdir[0] + '/'
 
154
            else:
 
155
                relroot = ""
 
156
            # FIXME: stash the node in pending
 
157
            entry = inv[currentdir[4]]
 
158
            for name, child in entry.sorted_children():
 
159
                toppath = relroot + name
 
160
                dirblock.append((toppath, name, child.kind, None,
 
161
                    child.file_id, child.kind
 
162
                    ))
 
163
            yield (currentdir[0], entry.file_id), dirblock
 
164
            # push the user specified dirs from dirblock
 
165
            for dir in reversed(dirblock):
 
166
                if dir[2] == _directory:
 
167
                    pending.append(dir)