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
"""Tree classes, representing directory at point in time.
21
import os.path, os, fnmatch
23
from osutils import pumpfile, filesize, quotefn, sha_file, \
24
joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
26
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
28
from inventory import Inventory
29
from trace import mutter, note
30
from errors import bailout
36
"""Abstract file tree.
38
There are several subclasses:
40
* `WorkingTree` exists as files on disk editable by the user.
42
* `RevisionTree` is a tree as recorded at some point in the past.
46
Trees contain an `Inventory` object, and also know how to retrieve
47
file texts mentioned in the inventory, either from a working
48
directory or from a store.
50
It is possible for trees to contain files that are not described
51
in their inventory or vice versa; for this use `filenames()`.
53
Trees can be compared, etc, regardless of whether they are working
54
trees or versioned trees.
57
def has_filename(self, filename):
58
"""True if the tree has given filename."""
59
raise NotImplementedError()
61
def has_id(self, file_id):
62
return self.inventory.has_id(file_id)
67
"""Return set of all ids in this tree."""
68
return self.inventory.id_set()
71
return iter(self.inventory)
73
def id2path(self, file_id):
74
return self.inventory.id2path(file_id)
76
def _get_inventory(self):
77
return self._inventory
79
inventory = property(_get_inventory,
80
doc="Inventory of this Tree")
82
def _check_retrieved(self, ie, f):
83
fp = fingerprint_file(f)
86
if ie.text_size != None:
87
if ie.text_size != fp['size']:
88
bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
89
["inventory expects %d bytes" % ie.text_size,
90
"file is actually %d bytes" % fp['size'],
91
"store is probably damaged/corrupt"])
93
if ie.text_sha1 != fp['sha1']:
94
bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
95
["inventory expects %s" % ie.text_sha1,
96
"file is actually %s" % fp['sha1'],
97
"store is probably damaged/corrupt"])
100
def print_file(self, fileid):
101
"""Print file with id `fileid` to stdout."""
103
pumpfile(self.get_file(fileid), sys.stdout)
106
def export(self, dest):
107
"""Export this tree to a new directory.
109
`dest` should not exist, and will be created holding the
110
contents of this tree.
112
TODO: To handle subdirectories we need to create the
115
:note: If the export fails, the destination directory will be
116
left in a half-assed state.
119
mutter('export version %r' % self)
121
for dp, ie in inv.iter_entries():
123
fullpath = appendpath(dest, dp)
124
if kind == 'directory':
127
pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
129
bailout("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
130
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
134
class RevisionTree(Tree):
135
"""Tree viewing a previous revision.
137
File text can be retrieved from the text store.
139
TODO: Some kind of `__repr__` method, but a good one
140
probably means knowing the branch and revision number,
141
or at least passing a description to the constructor.
144
def __init__(self, store, inv):
146
self._inventory = inv
148
def get_file(self, file_id):
149
ie = self._inventory[file_id]
150
f = self._store[ie.text_id]
151
mutter(" get fileid{%s} from %r" % (file_id, self))
152
self._check_retrieved(ie, f)
155
def get_file_size(self, file_id):
156
return self._inventory[file_id].text_size
158
def get_file_sha1(self, file_id):
159
ie = self._inventory[file_id]
162
def has_filename(self, filename):
163
return bool(self.inventory.path2id(filename))
165
def list_files(self):
166
# The only files returned by this are those from the version
167
for path, entry in self.inventory.iter_entries():
168
yield path, 'V', entry.kind, entry.file_id
171
class EmptyTree(Tree):
173
self._inventory = Inventory()
175
def has_filename(self, filename):
178
def list_files(self):
179
if False: # just to make it a generator
184
######################################################################
187
# TODO: Merge these two functions into a single one that can operate
188
# on either a whole tree or a set of files.
190
# TODO: Return the diff in order by filename, not by category or in
191
# random order. Can probably be done by lock-stepping through the
192
# filenames from both trees.
195
def file_status(filename, old_tree, new_tree):
196
"""Return single-letter status, old and new names for a file.
198
The complexity here is in deciding how to represent renames;
199
many complex cases are possible.
201
old_inv = old_tree.inventory
202
new_inv = new_tree.inventory
203
new_id = new_inv.path2id(filename)
204
old_id = old_inv.path2id(filename)
206
if not new_id and not old_id:
207
# easy: doesn't exist in either; not versioned at all
208
if new_tree.is_ignored(filename):
209
return 'I', None, None
211
return '?', None, None
213
# There is now a file of this name, great.
216
# There is no longer a file of this name, but we can describe
217
# what happened to the file that used to have
218
# this name. There are two possibilities: either it was
219
# deleted entirely, or renamed.
221
if new_inv.has_id(old_id):
222
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
224
return 'D', old_inv.id2path(old_id), None
226
# if the file_id is new in this revision, it is added
227
if new_id and not old_inv.has_id(new_id):
230
# if there used to be a file of this name, but that ID has now
231
# disappeared, it is deleted
232
if old_id and not new_inv.has_id(old_id):
239
def find_renames(old_inv, new_inv):
240
for file_id in old_inv:
241
if file_id not in new_inv:
243
old_name = old_inv.id2path(file_id)
244
new_name = new_inv.id2path(file_id)
245
if old_name != new_name:
246
yield (old_name, new_name)
added
removed
bzrlib/tree.py
