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
# TODO: Don't allow WorkingTrees to be constructed for remote branches.
19
# FIXME: I don't know if writing out the cache from the destructor is really a
20
# good idea, because destructors are considered poor taste in Python, and
21
# it's not predictable when it will be written out.
27
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
28
from bzrlib.errors import BzrCheckError
29
from bzrlib.trace import mutter
31
class WorkingTree(bzrlib.tree.Tree):
34
The inventory is held in the `Branch` working-inventory, and the
35
files are in a directory on disk.
37
It is possible for a `WorkingTree` to have a filename which is
38
not listed in the Inventory and vice versa.
40
def __init__(self, basedir, inv):
41
from bzrlib.hashcache import HashCache
42
from bzrlib.trace import note, mutter
45
self.basedir = basedir
46
self.path2id = inv.path2id
48
# update the whole cache up front and write to disk if anything changed;
49
# in the future we might want to do this more selectively
50
hc = self._hashcache = HashCache(basedir)
60
if self._hashcache.needs_write:
61
self._hashcache.write()
65
"""Iterate through file_ids for this tree.
67
file_ids are in a WorkingTree if they are in the working inventory
68
and the working file exists.
71
for path, ie in inv.iter_entries():
72
if os.path.exists(self.abspath(path)):
77
return "<%s of %s>" % (self.__class__.__name__,
78
getattr(self, 'basedir', None))
82
def abspath(self, filename):
83
return os.path.join(self.basedir, filename)
85
def has_filename(self, filename):
86
return os.path.exists(self.abspath(filename))
88
def get_file(self, file_id):
89
return self.get_file_byname(self.id2path(file_id))
91
def get_file_byname(self, filename):
92
return file(self.abspath(filename), 'rb')
94
def _get_store_filename(self, file_id):
95
## XXX: badly named; this isn't in the store at all
96
return self.abspath(self.id2path(file_id))
99
def id2abspath(self, file_id):
100
return self.abspath(self.id2path(file_id))
103
def has_id(self, file_id):
104
# files that have been deleted are excluded
105
inv = self._inventory
106
if not inv.has_id(file_id):
108
path = inv.id2path(file_id)
109
return os.path.exists(self.abspath(path))
112
__contains__ = has_id
115
def get_file_size(self, file_id):
116
return os.path.getsize(self.id2abspath(file_id))
119
def get_file_sha1(self, file_id):
120
path = self._inventory.id2path(file_id)
121
return self._hashcache.get_sha1(path)
124
def file_class(self, filename):
125
if self.path2id(filename):
127
elif self.is_ignored(filename):
133
def list_files(self):
134
"""Recursively list all files as (path, class, kind, id).
136
Lists, but does not descend into unversioned directories.
138
This does not include files that have been deleted in this
141
Skips the control directory.
143
inv = self._inventory
145
def descend(from_dir_relpath, from_dir_id, dp):
149
## TODO: If we find a subdirectory with its own .bzr
150
## directory, then that is a separate tree and we
151
## should exclude it.
152
if bzrlib.BZRDIR == f:
156
fp = appendpath(from_dir_relpath, f)
159
fap = appendpath(dp, f)
161
f_ie = inv.get_child(from_dir_id, f)
164
elif self.is_ignored(fp):
173
raise BzrCheckError("file %r entered as kind %r id %r, "
175
% (fap, f_ie.kind, f_ie.file_id, fk))
177
yield fp, c, fk, (f_ie and f_ie.file_id)
179
if fk != 'directory':
183
# don't descend unversioned directories
186
for ff in descend(fp, f_ie.file_id, fap):
189
for f in descend('', inv.root.file_id, self.basedir):
195
for subp in self.extras():
196
if not self.is_ignored(subp):
201
"""Yield all unknown files in this WorkingTree.
203
If there are any unknown directories then only the directory is
204
returned, not all its children. But if there are unknown files
205
under a versioned subdirectory, they are returned.
207
Currently returned depth-first, sorted by name within directories.
209
## TODO: Work from given directory downwards
210
for path, dir_entry in self.inventory.directories():
211
mutter("search for unknowns in %r" % path)
212
dirabs = self.abspath(path)
213
if not isdir(dirabs):
214
# e.g. directory deleted
218
for subf in os.listdir(dirabs):
220
and (subf not in dir_entry.children)):
225
subp = appendpath(path, subf)
229
def ignored_files(self):
230
"""Yield list of PATH, IGNORE_PATTERN"""
231
for subp in self.extras():
232
pat = self.is_ignored(subp)
237
def get_ignore_list(self):
238
"""Return list of ignore patterns.
240
Cached in the Tree object after the first call.
242
if hasattr(self, '_ignorelist'):
243
return self._ignorelist
245
l = bzrlib.DEFAULT_IGNORE[:]
246
if self.has_filename(bzrlib.IGNORE_FILENAME):
247
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
248
l.extend([line.rstrip("\n\r") for line in f.readlines()])
253
def is_ignored(self, filename):
254
r"""Check whether the filename matches an ignore pattern.
256
Patterns containing '/' or '\' need to match the whole path;
257
others match against only the last component.
259
If the file is ignored, returns the pattern which caused it to
260
be ignored, otherwise None. So this can simply be used as a
261
boolean if desired."""
263
# TODO: Use '**' to match directories, and other extended
264
# globbing stuff from cvs/rsync.
266
# XXX: fnmatch is actually not quite what we want: it's only
267
# approximately the same as real Unix fnmatch, and doesn't
268
# treat dotfiles correctly and allows * to match /.
269
# Eventually it should be replaced with something more
272
for pat in self.get_ignore_list():
273
if '/' in pat or '\\' in pat:
275
# as a special case, you can put ./ at the start of a
276
# pattern; this is good to match in the top-level
279
if (pat[:2] == './') or (pat[:2] == '.\\'):
283
if fnmatch.fnmatchcase(filename, newpat):
286
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
added
removed
bzrlib/workingtree.py
