2
# -*- coding: UTF-8 -*-
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Tree classes, representing directory at point in time.
22
import os.path, os, fnmatch
24
from inventory import Inventory
25
from trace import mutter, note
26
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
27
joinpath, splitpath, appendpath, isdir, isfile, file_kind
28
from errors import bailout
30
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
35
"""Abstract file tree.
37
There are several subclasses:
39
* `WorkingTree` exists as files on disk editable by the user.
41
* `RevisionTree` is a tree as recorded at some point in the past.
45
Trees contain an `Inventory` object, and also know how to retrieve
46
file texts mentioned in the inventory, either from a working
47
directory or from a store.
49
It is possible for trees to contain files that are not described
50
in their inventory or vice versa; for this use `filenames()`.
52
Trees can be compared, etc, regardless of whether they are working
53
trees or versioned trees.
56
def has_filename(self, filename):
57
"""True if the tree has given filename."""
58
raise NotImplementedError()
60
def has_id(self, file_id):
61
return self.inventory.has_id(file_id)
64
"""Return set of all ids in this tree."""
65
return self.inventory.id_set()
67
def id2path(self, file_id):
68
return self.inventory.id2path(file_id)
70
def _get_inventory(self):
71
return self._inventory
73
inventory = property(_get_inventory,
74
doc="Inventory of this Tree")
76
def _check_retrieved(self, ie, f):
77
# TODO: Test this check by damaging the store?
78
if ie.text_size is not None:
80
if fs != ie.text_size:
81
bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
82
["inventory expects %d bytes" % ie.text_size,
83
"file is actually %d bytes" % fs,
84
"store is probably damaged/corrupt"])
88
if ie.text_sha1 != f_hash:
89
bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
["inventory expects %s" % ie.text_sha1,
91
"file is actually %s" % f_hash,
92
"store is probably damaged/corrupt"])
95
def export(self, dest):
96
"""Export this tree to a new directory.
98
`dest` should not exist, and will be created holding the
99
contents of this tree.
101
:todo: To handle subdirectories we need to create the
104
:note: If the export fails, the destination directory will be
105
left in a half-assed state.
108
mutter('export version %r' % self)
110
for dp, ie in inv.iter_entries():
112
fullpath = appendpath(dest, dp)
113
if kind == 'directory':
116
pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
118
bailout("don't know how to export {%s} of kind %r", fid, kind)
119
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
123
class WorkingTree(Tree):
124
"""Working copy tree.
126
The inventory is held in the `Branch` working-inventory, and the
127
files are in a directory on disk.
129
It is possible for a `WorkingTree` to have a filename which is
130
not listed in the Inventory and vice versa.
132
def __init__(self, basedir, inv):
133
self._inventory = inv
134
self.basedir = basedir
135
self.path2id = inv.path2id
138
return "<%s of %s>" % (self.__class__.__name__,
141
def _rel(self, filename):
142
return os.path.join(self.basedir, filename)
144
def has_filename(self, filename):
145
return os.path.exists(self._rel(filename))
147
def get_file(self, file_id):
148
return self.get_file_byname(self.id2path(file_id))
150
def get_file_byname(self, filename):
151
return file(self._rel(filename), 'rb')
153
def _get_store_filename(self, file_id):
154
return self._rel(self.id2path(file_id))
156
def get_file_size(self, file_id):
157
return os.stat(self._get_store_filename(file_id))[ST_SIZE]
159
def get_file_sha1(self, file_id):
160
f = self.get_file(file_id)
164
def file_class(self, filename):
165
if self.path2id(filename):
167
elif self.is_ignored(filename):
173
def file_kind(self, filename):
174
if isfile(self._rel(filename)):
176
elif isdir(self._rel(filename)):
182
def list_files(self):
183
"""Recursively list all files as (path, class, kind, id).
185
Lists, but does not descend into unversioned directories.
187
This does not include files that have been deleted in this
190
Skips the control directory.
194
def descend(from_dir, from_dir_id, dp):
198
if bzrlib.BZRDIR == f:
202
fp = appendpath(from_dir, f)
205
fap = appendpath(dp, f)
207
f_ie = inv.get_child(from_dir_id, f)
210
elif self.is_ignored(fp):
219
bailout("file %r entered as kind %r id %r, now of kind %r"
220
% (fap, f_ie.kind, f_ie.file_id, fk))
222
yield fp, c, fk, (f_ie and f_ie.file_id)
224
if fk != 'directory':
228
# don't descend unversioned directories
231
for ff in descend(fp, f_ie.file_id, fap):
234
for f in descend('', None, self.basedir):
239
def unknowns(self, path='', dir_id=None):
240
"""Yield names of unknown files in this WorkingTree.
242
If there are any unknown directories then only the directory is
243
returned, not all its children. But if there are unknown files
244
under a versioned subdirectory, they are returned.
246
Currently returned depth-first, sorted by name within directories.
248
for fpath, fclass, fkind, fid in self.list_files():
253
def ignored_files(self):
254
for fpath, fclass, fkind, fid in self.list_files():
259
def get_ignore_list(self):
260
"""Return list of ignore patterns."""
261
if self.has_filename(bzrlib.IGNORE_FILENAME):
262
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
263
return [line.rstrip("\n\r") for line in f.readlines()]
265
return bzrlib.DEFAULT_IGNORE
268
def is_ignored(self, filename):
269
"""Check whether the filename matches an ignore pattern.
271
Patterns containing '/' need to match the whole path; others
272
match against only the last component."""
273
## TODO: Take them from a file, not hardcoded
274
## TODO: Use extended zsh-style globs maybe?
275
## TODO: Use '**' to match directories?
276
for pat in self.get_ignore_list():
278
if fnmatch.fnmatchcase(filename, pat):
281
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
289
class RevisionTree(Tree):
290
"""Tree viewing a previous revision.
292
File text can be retrieved from the text store.
294
:todo: Some kind of `__repr__` method, but a good one
295
probably means knowing the branch and revision number,
296
or at least passing a description to the constructor.
299
def __init__(self, store, inv):
301
self._inventory = inv
303
def get_file(self, file_id):
304
ie = self._inventory[file_id]
305
f = self._store[ie.text_id]
306
mutter(" get fileid{%s} from %r" % (file_id, self))
308
if ie.text_size is None:
309
note("warning: no text size recorded on %r" % ie)
310
self._check_retrieved(ie, f)
313
def get_file_size(self, file_id):
314
return self._inventory[file_id].text_size
316
def get_file_sha1(self, file_id):
317
ie = self._inventory[file_id]
320
def has_filename(self, filename):
321
return bool(self.inventory.path2id(filename))
323
def list_files(self):
324
# The only files returned by this are those from the version
325
for path, entry in self.inventory.iter_entries():
326
yield path, 'V', entry.kind, entry.file_id
329
class EmptyTree(Tree):
331
self._inventory = Inventory()
333
def has_filename(self, filename):
336
def list_files(self):
337
if False: # just to make it a generator
342
######################################################################
345
# TODO: Merge these two functions into a single one that can operate
346
# on either a whole tree or a set of files.
348
# TODO: Return the diff in order by filename, not by category or in
349
# random order. Can probably be done by lock-stepping through the
350
# filenames from both trees.
353
def file_status(filename, old_tree, new_tree):
354
"""Return single-letter status, old and new names for a file.
356
The complexity here is in deciding how to represent renames;
357
many complex cases are possible.
359
old_inv = old_tree.inventory
360
new_inv = new_tree.inventory
361
new_id = new_inv.path2id(filename)
362
old_id = old_inv.path2id(filename)
364
if not new_id and not old_id:
365
# easy: doesn't exist in either; not versioned at all
366
if new_tree.is_ignored(filename):
367
return 'I', None, None
369
return '?', None, None
371
# There is now a file of this name, great.
374
# There is no longer a file of this name, but we can describe
375
# what happened to the file that used to have
376
# this name. There are two possibilities: either it was
377
# deleted entirely, or renamed.
379
if new_inv.has_id(old_id):
380
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
382
return 'D', old_inv.id2path(old_id), None
384
# if the file_id is new in this revision, it is added
385
if new_id and not old_inv.has_id(new_id):
388
# if there used to be a file of this name, but that ID has now
389
# disappeared, it is deleted
390
if old_id and not new_inv.has_id(old_id):
added
removed
bzrlib/tree.py
