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.
28
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
29
from bzrlib.errors import BzrCheckError
30
from bzrlib.trace import mutter
32
class WorkingTree(bzrlib.tree.Tree):
35
The inventory is held in the `Branch` working-inventory, and the
36
files are in a directory on disk.
38
It is possible for a `WorkingTree` to have a filename which is
39
not listed in the Inventory and vice versa.
41
def __init__(self, basedir, inv):
42
from bzrlib.hashcache import HashCache
43
from bzrlib.trace import note, mutter
46
self.basedir = basedir
47
self.path2id = inv.path2id
49
# update the whole cache up front and write to disk if anything changed;
50
# in the future we might want to do this more selectively
51
hc = self._hashcache = HashCache(basedir)
61
if self._hashcache.needs_write:
62
self._hashcache.write()
66
"""Iterate through file_ids for this tree.
68
file_ids are in a WorkingTree if they are in the working inventory
69
and the working file exists.
72
for path, ie in inv.iter_entries():
73
if bzrlib.osutils.lexists(self.abspath(path)):
78
return "<%s of %s>" % (self.__class__.__name__,
79
getattr(self, 'basedir', None))
83
def abspath(self, filename):
84
return os.path.join(self.basedir, filename)
86
def has_filename(self, filename):
87
return bzrlib.osutils.lexists(self.abspath(filename))
89
def get_file(self, file_id):
90
return self.get_file_byname(self.id2path(file_id))
92
def get_file_byname(self, filename):
93
return file(self.abspath(filename), 'rb')
95
def _get_store_filename(self, file_id):
96
## XXX: badly named; this isn't in the store at all
97
return self.abspath(self.id2path(file_id))
100
def id2abspath(self, file_id):
101
return self.abspath(self.id2path(file_id))
104
def has_id(self, file_id):
105
# files that have been deleted are excluded
106
inv = self._inventory
107
if not inv.has_id(file_id):
109
path = inv.id2path(file_id)
110
return bzrlib.osutils.lexists(self.abspath(path))
113
__contains__ = has_id
116
def get_file_size(self, file_id):
117
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 is_executable(self, file_id):
126
return self._inventory[file_id].executable
128
path = self._inventory.id2path(file_id)
129
mode = os.lstat(self.abspath(path)).st_mode
130
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
132
def get_symlink_target(self, file_id):
133
return os.readlink(self.id2path(file_id))
135
def file_class(self, filename):
136
if self.path2id(filename):
138
elif self.is_ignored(filename):
144
def list_files(self):
145
"""Recursively list all files as (path, class, kind, id).
147
Lists, but does not descend into unversioned directories.
149
This does not include files that have been deleted in this
152
Skips the control directory.
154
inv = self._inventory
156
def descend(from_dir_relpath, from_dir_id, dp):
160
## TODO: If we find a subdirectory with its own .bzr
161
## directory, then that is a separate tree and we
162
## should exclude it.
163
if bzrlib.BZRDIR == f:
167
fp = appendpath(from_dir_relpath, f)
170
fap = appendpath(dp, f)
172
f_ie = inv.get_child(from_dir_id, f)
175
elif self.is_ignored(fp):
184
raise BzrCheckError("file %r entered as kind %r id %r, "
186
% (fap, f_ie.kind, f_ie.file_id, fk))
188
yield fp, c, fk, (f_ie and f_ie.file_id)
190
if fk != 'directory':
194
# don't descend unversioned directories
197
for ff in descend(fp, f_ie.file_id, fap):
200
for f in descend('', inv.root.file_id, self.basedir):
206
for subp in self.extras():
207
if not self.is_ignored(subp):
212
"""Yield all unknown files in this WorkingTree.
214
If there are any unknown directories then only the directory is
215
returned, not all its children. But if there are unknown files
216
under a versioned subdirectory, they are returned.
218
Currently returned depth-first, sorted by name within directories.
220
## TODO: Work from given directory downwards
221
for path, dir_entry in self.inventory.directories():
222
mutter("search for unknowns in %r" % path)
223
dirabs = self.abspath(path)
224
if not isdir(dirabs):
225
# e.g. directory deleted
229
for subf in os.listdir(dirabs):
231
and (subf not in dir_entry.children)):
236
subp = appendpath(path, subf)
240
def ignored_files(self):
241
"""Yield list of PATH, IGNORE_PATTERN"""
242
for subp in self.extras():
243
pat = self.is_ignored(subp)
248
def get_ignore_list(self):
249
"""Return list of ignore patterns.
251
Cached in the Tree object after the first call.
253
if hasattr(self, '_ignorelist'):
254
return self._ignorelist
256
l = bzrlib.DEFAULT_IGNORE[:]
257
if self.has_filename(bzrlib.IGNORE_FILENAME):
258
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
259
l.extend([line.rstrip("\n\r") for line in f.readlines()])
264
def is_ignored(self, filename):
265
r"""Check whether the filename matches an ignore pattern.
267
Patterns containing '/' or '\' need to match the whole path;
268
others match against only the last component.
270
If the file is ignored, returns the pattern which caused it to
271
be ignored, otherwise None. So this can simply be used as a
272
boolean if desired."""
274
# TODO: Use '**' to match directories, and other extended
275
# globbing stuff from cvs/rsync.
277
# XXX: fnmatch is actually not quite what we want: it's only
278
# approximately the same as real Unix fnmatch, and doesn't
279
# treat dotfiles correctly and allows * to match /.
280
# Eventually it should be replaced with something more
283
for pat in self.get_ignore_list():
284
if '/' in pat or '\\' in pat:
286
# as a special case, you can put ./ at the start of a
287
# pattern; this is good to match in the top-level
290
if (pat[:2] == './') or (pat[:2] == '.\\'):
294
if fnmatch.fnmatchcase(filename, newpat):
297
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
added
removed
bzrlib/workingtree.py
