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
21
from errors import BzrCheckError
22
from trace import mutter
25
class WorkingTree(bzrlib.tree.Tree):
28
The inventory is held in the `Branch` working-inventory, and the
29
files are in a directory on disk.
31
It is possible for a `WorkingTree` to have a filename which is
32
not listed in the Inventory and vice versa.
36
def __init__(self, basedir, inv):
38
self.basedir = basedir
39
self.path2id = inv.path2id
40
self._update_statcache()
43
"""Iterate through file_ids for this tree.
45
file_ids are in a WorkingTree if they are in the working inventory
46
and the working file exists.
49
for file_id in self._inventory:
50
# TODO: This is slightly redundant; we should be able to just
51
# check the statcache but it only includes regular files.
52
# only include files which still exist on disk
55
if ((file_id in self._statcache)
56
or (os.path.exists(self.abspath(inv.id2path(file_id))))):
62
return "<%s of %s>" % (self.__class__.__name__,
65
def abspath(self, filename):
66
return os.path.join(self.basedir, filename)
68
def has_filename(self, filename):
69
return os.path.exists(self.abspath(filename))
71
def get_file(self, file_id):
72
return self.get_file_byname(self.id2path(file_id))
74
def get_file_byname(self, filename):
75
return file(self.abspath(filename), 'rb')
77
def _get_store_filename(self, file_id):
78
## XXX: badly named; this isn't in the store at all
79
return self.abspath(self.id2path(file_id))
82
def has_id(self, file_id):
83
# files that have been deleted are excluded
84
if not self.inventory.has_id(file_id):
86
if file_id in self._statcache:
88
return os.path.exists(self.abspath(self.id2path(file_id)))
94
def _update_statcache(self):
96
if not self._statcache:
97
self._statcache = statcache.update_cache(self.basedir, self.inventory)
99
def get_file_size(self, file_id):
101
return os.stat(self._get_store_filename(file_id))[stat.ST_SIZE]
104
def get_file_sha1(self, file_id):
105
return self._statcache[file_id][statcache.SC_SHA1]
108
def file_class(self, filename):
109
if self.path2id(filename):
111
elif self.is_ignored(filename):
117
def list_files(self):
118
"""Recursively list all files as (path, class, kind, id).
120
Lists, but does not descend into unversioned directories.
122
This does not include files that have been deleted in this
125
Skips the control directory.
127
from osutils import appendpath, file_kind
132
def descend(from_dir_relpath, from_dir_id, dp):
136
## TODO: If we find a subdirectory with its own .bzr
137
## directory, then that is a separate tree and we
138
## should exclude it.
139
if bzrlib.BZRDIR == f:
143
fp = appendpath(from_dir_relpath, f)
146
fap = appendpath(dp, f)
148
f_ie = inv.get_child(from_dir_id, f)
151
elif self.is_ignored(fp):
160
raise BzrCheckError("file %r entered as kind %r id %r, "
162
% (fap, f_ie.kind, f_ie.file_id, fk))
164
yield fp, c, fk, (f_ie and f_ie.file_id)
166
if fk != 'directory':
170
# don't descend unversioned directories
173
for ff in descend(fp, f_ie.file_id, fap):
176
for f in descend('', inv.root.file_id, self.basedir):
182
for subp in self.extras():
183
if not self.is_ignored(subp):
188
"""Yield all unknown files in this WorkingTree.
190
If there are any unknown directories then only the directory is
191
returned, not all its children. But if there are unknown files
192
under a versioned subdirectory, they are returned.
194
Currently returned depth-first, sorted by name within directories.
196
## TODO: Work from given directory downwards
197
from osutils import isdir, appendpath
199
for path, dir_entry in self.inventory.directories():
200
mutter("search for unknowns in %r" % path)
201
dirabs = self.abspath(path)
202
if not isdir(dirabs):
203
# e.g. directory deleted
207
for subf in os.listdir(dirabs):
209
and (subf not in dir_entry.children)):
214
subp = appendpath(path, subf)
218
def ignored_files(self):
219
"""Yield list of PATH, IGNORE_PATTERN"""
220
for subp in self.extras():
221
pat = self.is_ignored(subp)
226
def get_ignore_list(self):
227
"""Return list of ignore patterns.
229
Cached in the Tree object after the first call.
231
if hasattr(self, '_ignorelist'):
232
return self._ignorelist
234
l = bzrlib.DEFAULT_IGNORE[:]
235
if self.has_filename(bzrlib.IGNORE_FILENAME):
236
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
237
l.extend([line.rstrip("\n\r") for line in f.readlines()])
242
def is_ignored(self, filename):
243
r"""Check whether the filename matches an ignore pattern.
245
Patterns containing '/' or '\' need to match the whole path;
246
others match against only the last component.
248
If the file is ignored, returns the pattern which caused it to
249
be ignored, otherwise None. So this can simply be used as a
250
boolean if desired."""
252
# TODO: Use '**' to match directories, and other extended
253
# globbing stuff from cvs/rsync.
255
# XXX: fnmatch is actually not quite what we want: it's only
256
# approximately the same as real Unix fnmatch, and doesn't
257
# treat dotfiles correctly and allows * to match /.
258
# Eventually it should be replaced with something more
262
from osutils import splitpath
264
for pat in self.get_ignore_list():
265
if '/' in pat or '\\' in pat:
267
# as a special case, you can put ./ at the start of a
268
# pattern; this is good to match in the top-level
271
if (pat[:2] == './') or (pat[:2] == '.\\'):
275
if fnmatch.fnmatchcase(filename, newpat):
278
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
added
removed
bzrlib/workingtree.py
