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
42
"""Iterate through file_ids for this tree.
44
file_ids are in a WorkingTree if they are in the working inventory
45
and the working file exists.
47
self._update_statcache()
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
self._update_statcache()
87
if file_id in self._statcache:
89
return os.path.exists(self.abspath(self.id2path(file_id)))
95
def _update_statcache(self):
97
if not self._statcache:
98
self._statcache = statcache.update_cache(self.basedir, self.inventory)
100
def get_file_size(self, file_id):
102
return os.stat(self._get_store_filename(file_id))[stat.ST_SIZE]
105
def get_file_sha1(self, file_id):
107
self._update_statcache()
108
return self._statcache[file_id][statcache.SC_SHA1]
111
def file_class(self, filename):
112
if self.path2id(filename):
114
elif self.is_ignored(filename):
120
def list_files(self):
121
"""Recursively list all files as (path, class, kind, id).
123
Lists, but does not descend into unversioned directories.
125
This does not include files that have been deleted in this
128
Skips the control directory.
130
from osutils import appendpath, file_kind
135
def descend(from_dir_relpath, from_dir_id, dp):
139
## TODO: If we find a subdirectory with its own .bzr
140
## directory, then that is a separate tree and we
141
## should exclude it.
142
if bzrlib.BZRDIR == f:
146
fp = appendpath(from_dir_relpath, f)
149
fap = appendpath(dp, f)
151
f_ie = inv.get_child(from_dir_id, f)
154
elif self.is_ignored(fp):
163
raise BzrCheckError("file %r entered as kind %r id %r, "
165
% (fap, f_ie.kind, f_ie.file_id, fk))
167
yield fp, c, fk, (f_ie and f_ie.file_id)
169
if fk != 'directory':
173
# don't descend unversioned directories
176
for ff in descend(fp, f_ie.file_id, fap):
179
for f in descend('', inv.root.file_id, self.basedir):
185
for subp in self.extras():
186
if not self.is_ignored(subp):
191
"""Yield all unknown files in this WorkingTree.
193
If there are any unknown directories then only the directory is
194
returned, not all its children. But if there are unknown files
195
under a versioned subdirectory, they are returned.
197
Currently returned depth-first, sorted by name within directories.
199
## TODO: Work from given directory downwards
200
from osutils import isdir, appendpath
202
for path, dir_entry in self.inventory.directories():
203
mutter("search for unknowns in %r" % path)
204
dirabs = self.abspath(path)
205
if not isdir(dirabs):
206
# e.g. directory deleted
210
for subf in os.listdir(dirabs):
212
and (subf not in dir_entry.children)):
217
subp = appendpath(path, subf)
221
def ignored_files(self):
222
"""Yield list of PATH, IGNORE_PATTERN"""
223
for subp in self.extras():
224
pat = self.is_ignored(subp)
229
def get_ignore_list(self):
230
"""Return list of ignore patterns.
232
Cached in the Tree object after the first call.
234
if hasattr(self, '_ignorelist'):
235
return self._ignorelist
237
l = bzrlib.DEFAULT_IGNORE[:]
238
if self.has_filename(bzrlib.IGNORE_FILENAME):
239
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
240
l.extend([line.rstrip("\n\r") for line in f.readlines()])
245
def is_ignored(self, filename):
246
r"""Check whether the filename matches an ignore pattern.
248
Patterns containing '/' or '\' need to match the whole path;
249
others match against only the last component.
251
If the file is ignored, returns the pattern which caused it to
252
be ignored, otherwise None. So this can simply be used as a
253
boolean if desired."""
255
# TODO: Use '**' to match directories, and other extended
256
# globbing stuff from cvs/rsync.
258
# XXX: fnmatch is actually not quite what we want: it's only
259
# approximately the same as real Unix fnmatch, and doesn't
260
# treat dotfiles correctly and allows * to match /.
261
# Eventually it should be replaced with something more
265
from osutils import splitpath
267
for pat in self.get_ignore_list():
268
if '/' in pat or '\\' in pat:
270
# as a special case, you can put ./ at the start of a
271
# pattern; this is good to match in the top-level
274
if (pat[:2] == './') or (pat[:2] == '.\\'):
278
if fnmatch.fnmatchcase(filename, newpat):
281
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
added
removed
bzrlib/workingtree.py
