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.branch import Branch
29
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath, relpath
30
from bzrlib.errors import BzrCheckError
31
from bzrlib.trace import mutter
33
class TreeEntry(object):
34
"""An entry that implements the minium interface used by commands.
36
This needs further inspection, it may be better to have
37
InventoryEntries without ids - though that seems wrong. For now,
38
this is a parallel hierarchy to InventoryEntry, and needs to become
39
one of several things: decorates to that hierarchy, children of, or
41
Another note is that these objects are currently only used when there is
42
no InventoryEntry available - i.e. for unversioned objects.
43
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
46
def __eq__(self, other):
47
# yes, this us ugly, TODO: best practice __eq__ style.
48
return (isinstance(other, TreeEntry)
49
and other.__class__ == self.__class__)
51
def kind_character(self):
55
class TreeDirectory(TreeEntry):
56
"""See TreeEntry. This is a directory in a working tree."""
58
def __eq__(self, other):
59
return (isinstance(other, TreeDirectory)
60
and other.__class__ == self.__class__)
62
def kind_character(self):
66
class TreeFile(TreeEntry):
67
"""See TreeEntry. This is a regular file in a working tree."""
69
def __eq__(self, other):
70
return (isinstance(other, TreeFile)
71
and other.__class__ == self.__class__)
73
def kind_character(self):
77
class TreeLink(TreeEntry):
78
"""See TreeEntry. This is a symlink in a working tree."""
80
def __eq__(self, other):
81
return (isinstance(other, TreeLink)
82
and other.__class__ == self.__class__)
84
def kind_character(self):
88
class WorkingTree(bzrlib.tree.Tree):
91
The inventory is held in the `Branch` working-inventory, and the
92
files are in a directory on disk.
94
It is possible for a `WorkingTree` to have a filename which is
95
not listed in the Inventory and vice versa.
97
def __init__(self, basedir, branch=None):
98
"""Construct a WorkingTree for basedir.
100
If the branch is not supplied, it is opened automatically.
101
If the branch is supplied, it must be the branch for this basedir.
102
(branch.base is not cross checked, because for remote branches that
103
would be meaningless).
105
from bzrlib.hashcache import HashCache
106
from bzrlib.trace import note, mutter
109
branch = Branch.open(basedir)
110
self._inventory = branch.inventory
111
self.path2id = self._inventory.path2id
113
self.basedir = basedir
115
# update the whole cache up front and write to disk if anything changed;
116
# in the future we might want to do this more selectively
117
hc = self._hashcache = HashCache(basedir)
127
if self._hashcache.needs_write:
128
self._hashcache.write()
132
"""Iterate through file_ids for this tree.
134
file_ids are in a WorkingTree if they are in the working inventory
135
and the working file exists.
137
inv = self._inventory
138
for path, ie in inv.iter_entries():
139
if bzrlib.osutils.lexists(self.abspath(path)):
144
return "<%s of %s>" % (self.__class__.__name__,
145
getattr(self, 'basedir', None))
149
def abspath(self, filename):
150
return os.path.join(self.basedir, filename)
152
def relpath(self, abspath):
153
"""Return the local path portion from a given absolute path."""
154
return relpath(self.basedir, abspath)
156
def has_filename(self, filename):
157
return bzrlib.osutils.lexists(self.abspath(filename))
159
def get_file(self, file_id):
160
return self.get_file_byname(self.id2path(file_id))
162
def get_file_byname(self, filename):
163
return file(self.abspath(filename), 'rb')
165
def _get_store_filename(self, file_id):
166
## XXX: badly named; this isn't in the store at all
167
return self.abspath(self.id2path(file_id))
170
def id2abspath(self, file_id):
171
return self.abspath(self.id2path(file_id))
174
def has_id(self, file_id):
175
# files that have been deleted are excluded
176
inv = self._inventory
177
if not inv.has_id(file_id):
179
path = inv.id2path(file_id)
180
return bzrlib.osutils.lexists(self.abspath(path))
182
def has_or_had_id(self, file_id):
183
if file_id == self.inventory.root.file_id:
185
return self.inventory.has_id(file_id)
187
__contains__ = has_id
190
def get_file_size(self, file_id):
191
return os.path.getsize(self.id2abspath(file_id))
193
def get_file_sha1(self, file_id):
194
path = self._inventory.id2path(file_id)
195
return self._hashcache.get_sha1(path)
198
def is_executable(self, file_id):
200
return self._inventory[file_id].executable
202
path = self._inventory.id2path(file_id)
203
mode = os.lstat(self.abspath(path)).st_mode
204
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
206
def get_symlink_target(self, file_id):
207
return os.readlink(self.id2abspath(file_id))
209
def file_class(self, filename):
210
if self.path2id(filename):
212
elif self.is_ignored(filename):
218
def list_files(self):
219
"""Recursively list all files as (path, class, kind, id).
221
Lists, but does not descend into unversioned directories.
223
This does not include files that have been deleted in this
226
Skips the control directory.
228
inv = self._inventory
230
def descend(from_dir_relpath, from_dir_id, dp):
234
## TODO: If we find a subdirectory with its own .bzr
235
## directory, then that is a separate tree and we
236
## should exclude it.
237
if bzrlib.BZRDIR == f:
241
fp = appendpath(from_dir_relpath, f)
244
fap = appendpath(dp, f)
246
f_ie = inv.get_child(from_dir_id, f)
249
elif self.is_ignored(fp):
258
raise BzrCheckError("file %r entered as kind %r id %r, "
260
% (fap, f_ie.kind, f_ie.file_id, fk))
262
# make a last minute entry
266
if fk == 'directory':
267
entry = TreeDirectory()
270
elif fk == 'symlink':
275
yield fp, c, fk, (f_ie and f_ie.file_id), entry
277
if fk != 'directory':
281
# don't descend unversioned directories
284
for ff in descend(fp, f_ie.file_id, fap):
287
for f in descend('', inv.root.file_id, self.basedir):
293
for subp in self.extras():
294
if not self.is_ignored(subp):
297
def iter_conflicts(self):
299
for path in (s[0] for s in self.list_files()):
300
stem = get_conflicted_stem(path)
303
if stem not in conflicted:
308
"""Yield all unknown files in this WorkingTree.
310
If there are any unknown directories then only the directory is
311
returned, not all its children. But if there are unknown files
312
under a versioned subdirectory, they are returned.
314
Currently returned depth-first, sorted by name within directories.
316
## TODO: Work from given directory downwards
317
for path, dir_entry in self.inventory.directories():
318
mutter("search for unknowns in %r" % path)
319
dirabs = self.abspath(path)
320
if not isdir(dirabs):
321
# e.g. directory deleted
325
for subf in os.listdir(dirabs):
327
and (subf not in dir_entry.children)):
332
subp = appendpath(path, subf)
336
def ignored_files(self):
337
"""Yield list of PATH, IGNORE_PATTERN"""
338
for subp in self.extras():
339
pat = self.is_ignored(subp)
344
def get_ignore_list(self):
345
"""Return list of ignore patterns.
347
Cached in the Tree object after the first call.
349
if hasattr(self, '_ignorelist'):
350
return self._ignorelist
352
l = bzrlib.DEFAULT_IGNORE[:]
353
if self.has_filename(bzrlib.IGNORE_FILENAME):
354
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
355
l.extend([line.rstrip("\n\r") for line in f.readlines()])
360
def is_ignored(self, filename):
361
r"""Check whether the filename matches an ignore pattern.
363
Patterns containing '/' or '\' need to match the whole path;
364
others match against only the last component.
366
If the file is ignored, returns the pattern which caused it to
367
be ignored, otherwise None. So this can simply be used as a
368
boolean if desired."""
370
# TODO: Use '**' to match directories, and other extended
371
# globbing stuff from cvs/rsync.
373
# XXX: fnmatch is actually not quite what we want: it's only
374
# approximately the same as real Unix fnmatch, and doesn't
375
# treat dotfiles correctly and allows * to match /.
376
# Eventually it should be replaced with something more
379
for pat in self.get_ignore_list():
380
if '/' in pat or '\\' in pat:
382
# as a special case, you can put ./ at the start of a
383
# pattern; this is good to match in the top-level
386
if (pat[:2] == './') or (pat[:2] == '.\\'):
390
if fnmatch.fnmatchcase(filename, newpat):
393
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
398
def kind(self, file_id):
399
return file_kind(self.id2abspath(file_id))
401
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
402
def get_conflicted_stem(path):
403
for suffix in CONFLICT_SUFFIXES:
404
if path.endswith(suffix):
405
return path[:-len(suffix)]
added
removed
bzrlib/workingtree.py
