~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

[merge] bzr.dev 2255, resolve conflicts, update copyrights

Show diffs side-by-side

added added

removed removed

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