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
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call Branch.working_tree():
32
# TODO: Don't allow WorkingTrees to be constructed for remote branches if
35
# FIXME: I don't know if writing out the cache from the destructor is really a
36
# good idea, because destructors are considered poor taste in Python, and it's
37
# not predictable when it will be written out.
39
# TODO: Give the workingtree sole responsibility for the working inventory;
40
# remove the variable and references to it from the branch. This may require
41
# updating the commit code so as to update the inventory within the working
42
# copy, and making sure there's only one WorkingTree for any directory on disk.
43
# At the momenthey may alias the inventory and have old copies of it in memory.
49
from bzrlib.branch import Branch, needs_read_lock, needs_write_lock, quotefn
51
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath, relpath
52
from bzrlib.errors import BzrCheckError, DivergedBranches, NotVersionedError
53
from bzrlib.trace import mutter
56
class TreeEntry(object):
57
"""An entry that implements the minium interface used by commands.
59
This needs further inspection, it may be better to have
60
InventoryEntries without ids - though that seems wrong. For now,
61
this is a parallel hierarchy to InventoryEntry, and needs to become
62
one of several things: decorates to that hierarchy, children of, or
64
Another note is that these objects are currently only used when there is
65
no InventoryEntry available - i.e. for unversioned objects.
66
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
69
def __eq__(self, other):
70
# yes, this us ugly, TODO: best practice __eq__ style.
71
return (isinstance(other, TreeEntry)
72
and other.__class__ == self.__class__)
74
def kind_character(self):
78
class TreeDirectory(TreeEntry):
79
"""See TreeEntry. This is a directory in a working tree."""
81
def __eq__(self, other):
82
return (isinstance(other, TreeDirectory)
83
and other.__class__ == self.__class__)
85
def kind_character(self):
89
class TreeFile(TreeEntry):
90
"""See TreeEntry. This is a regular file in a working tree."""
92
def __eq__(self, other):
93
return (isinstance(other, TreeFile)
94
and other.__class__ == self.__class__)
96
def kind_character(self):
100
class TreeLink(TreeEntry):
101
"""See TreeEntry. This is a symlink in a working tree."""
103
def __eq__(self, other):
104
return (isinstance(other, TreeLink)
105
and other.__class__ == self.__class__)
107
def kind_character(self):
111
class WorkingTree(bzrlib.tree.Tree):
112
"""Working copy tree.
114
The inventory is held in the `Branch` working-inventory, and the
115
files are in a directory on disk.
117
It is possible for a `WorkingTree` to have a filename which is
118
not listed in the Inventory and vice versa.
121
def __init__(self, basedir, branch=None):
122
"""Construct a WorkingTree for basedir.
124
If the branch is not supplied, it is opened automatically.
125
If the branch is supplied, it must be the branch for this basedir.
126
(branch.base is not cross checked, because for remote branches that
127
would be meaningless).
129
from bzrlib.hashcache import HashCache
130
from bzrlib.trace import note, mutter
131
assert isinstance(basedir, basestring), \
132
"base directory %r is not a string" % basedir
134
branch = Branch.open(basedir)
135
assert isinstance(branch, Branch), \
136
"branch %r is not a Branch" % branch
137
self._inventory = branch.inventory
138
self.path2id = self._inventory.path2id
140
self.basedir = basedir
142
# update the whole cache up front and write to disk if anything changed;
143
# in the future we might want to do this more selectively
144
hc = self._hashcache = HashCache(basedir)
154
if self._hashcache.needs_write:
155
self._hashcache.write()
159
"""Iterate through file_ids for this tree.
161
file_ids are in a WorkingTree if they are in the working inventory
162
and the working file exists.
164
inv = self._inventory
165
for path, ie in inv.iter_entries():
166
if bzrlib.osutils.lexists(self.abspath(path)):
171
return "<%s of %s>" % (self.__class__.__name__,
172
getattr(self, 'basedir', None))
176
def abspath(self, filename):
177
return os.path.join(self.basedir, filename)
179
def relpath(self, abspath):
180
"""Return the local path portion from a given absolute path."""
181
return relpath(self.basedir, abspath)
183
def has_filename(self, filename):
184
return bzrlib.osutils.lexists(self.abspath(filename))
186
def get_file(self, file_id):
187
return self.get_file_byname(self.id2path(file_id))
189
def get_file_byname(self, filename):
190
return file(self.abspath(filename), 'rb')
192
def _get_store_filename(self, file_id):
193
## XXX: badly named; this isn't in the store at all
194
return self.abspath(self.id2path(file_id))
197
def id2abspath(self, file_id):
198
return self.abspath(self.id2path(file_id))
201
def has_id(self, file_id):
202
# files that have been deleted are excluded
203
inv = self._inventory
204
if not inv.has_id(file_id):
206
path = inv.id2path(file_id)
207
return bzrlib.osutils.lexists(self.abspath(path))
209
def has_or_had_id(self, file_id):
210
if file_id == self.inventory.root.file_id:
212
return self.inventory.has_id(file_id)
214
__contains__ = has_id
217
def get_file_size(self, file_id):
218
return os.path.getsize(self.id2abspath(file_id))
220
def get_file_sha1(self, file_id):
221
path = self._inventory.id2path(file_id)
222
return self._hashcache.get_sha1(path)
225
def is_executable(self, file_id):
227
return self._inventory[file_id].executable
229
path = self._inventory.id2path(file_id)
230
mode = os.lstat(self.abspath(path)).st_mode
231
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
233
def get_symlink_target(self, file_id):
234
return os.readlink(self.id2abspath(file_id))
236
def file_class(self, filename):
237
if self.path2id(filename):
239
elif self.is_ignored(filename):
245
def list_files(self):
246
"""Recursively list all files as (path, class, kind, id).
248
Lists, but does not descend into unversioned directories.
250
This does not include files that have been deleted in this
253
Skips the control directory.
255
inv = self._inventory
257
def descend(from_dir_relpath, from_dir_id, dp):
261
## TODO: If we find a subdirectory with its own .bzr
262
## directory, then that is a separate tree and we
263
## should exclude it.
264
if bzrlib.BZRDIR == f:
268
fp = appendpath(from_dir_relpath, f)
271
fap = appendpath(dp, f)
273
f_ie = inv.get_child(from_dir_id, f)
276
elif self.is_ignored(fp):
285
raise BzrCheckError("file %r entered as kind %r id %r, "
287
% (fap, f_ie.kind, f_ie.file_id, fk))
289
# make a last minute entry
293
if fk == 'directory':
294
entry = TreeDirectory()
297
elif fk == 'symlink':
302
yield fp, c, fk, (f_ie and f_ie.file_id), entry
304
if fk != 'directory':
308
# don't descend unversioned directories
311
for ff in descend(fp, f_ie.file_id, fap):
314
for f in descend('', inv.root.file_id, self.basedir):
320
for subp in self.extras():
321
if not self.is_ignored(subp):
324
def iter_conflicts(self):
326
for path in (s[0] for s in self.list_files()):
327
stem = get_conflicted_stem(path)
330
if stem not in conflicted:
335
def pull(self, source, remember=False, clobber=False):
336
from bzrlib.merge import merge_inner
339
old_revision_history = self.branch.revision_history()
341
self.branch.update_revisions(source)
342
except DivergedBranches:
345
self.branch.set_revision_history(source.revision_history())
346
new_revision_history = self.branch.revision_history()
347
if new_revision_history != old_revision_history:
348
if len(old_revision_history):
349
other_revision = old_revision_history[-1]
351
other_revision = None
352
merge_inner(self.branch,
353
self.branch.basis_tree(),
354
self.branch.revision_tree(other_revision))
355
if self.branch.get_parent() is None or remember:
356
self.branch.set_parent(source.base)
361
"""Yield all unknown files in this WorkingTree.
363
If there are any unknown directories then only the directory is
364
returned, not all its children. But if there are unknown files
365
under a versioned subdirectory, they are returned.
367
Currently returned depth-first, sorted by name within directories.
369
## TODO: Work from given directory downwards
370
for path, dir_entry in self.inventory.directories():
371
mutter("search for unknowns in %r" % path)
372
dirabs = self.abspath(path)
373
if not isdir(dirabs):
374
# e.g. directory deleted
378
for subf in os.listdir(dirabs):
380
and (subf not in dir_entry.children)):
385
subp = appendpath(path, subf)
389
def ignored_files(self):
390
"""Yield list of PATH, IGNORE_PATTERN"""
391
for subp in self.extras():
392
pat = self.is_ignored(subp)
397
def get_ignore_list(self):
398
"""Return list of ignore patterns.
400
Cached in the Tree object after the first call.
402
if hasattr(self, '_ignorelist'):
403
return self._ignorelist
405
l = bzrlib.DEFAULT_IGNORE[:]
406
if self.has_filename(bzrlib.IGNORE_FILENAME):
407
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
408
l.extend([line.rstrip("\n\r") for line in f.readlines()])
413
def is_ignored(self, filename):
414
r"""Check whether the filename matches an ignore pattern.
416
Patterns containing '/' or '\' need to match the whole path;
417
others match against only the last component.
419
If the file is ignored, returns the pattern which caused it to
420
be ignored, otherwise None. So this can simply be used as a
421
boolean if desired."""
423
# TODO: Use '**' to match directories, and other extended
424
# globbing stuff from cvs/rsync.
426
# XXX: fnmatch is actually not quite what we want: it's only
427
# approximately the same as real Unix fnmatch, and doesn't
428
# treat dotfiles correctly and allows * to match /.
429
# Eventually it should be replaced with something more
432
for pat in self.get_ignore_list():
433
if '/' in pat or '\\' in pat:
435
# as a special case, you can put ./ at the start of a
436
# pattern; this is good to match in the top-level
439
if (pat[:2] == './') or (pat[:2] == '.\\'):
443
if fnmatch.fnmatchcase(filename, newpat):
446
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
451
def kind(self, file_id):
452
return file_kind(self.id2abspath(file_id))
455
"""See Branch.lock_read, and WorkingTree.unlock."""
456
return self.branch.lock_read()
458
def lock_write(self):
459
"""See Branch.lock_write, and WorkingTree.unlock."""
460
return self.branch.lock_write()
463
def remove(self, files, verbose=False):
464
"""Remove nominated files from the working inventory..
466
This does not remove their text. This does not run on XXX on what? RBC
468
TODO: Refuse to remove modified files unless --force is given?
470
TODO: Do something useful with directories.
472
TODO: Should this remove the text or not? Tough call; not
473
removing may be useful and the user can just use use rm, and
474
is the opposite of add. Removing it is consistent with most
475
other tools. Maybe an option.
477
## TODO: Normalize names
478
## TODO: Remove nested loops; better scalability
479
if isinstance(files, basestring):
484
# do this before any modifications
488
# TODO: Perhaps make this just a warning, and continue?
489
# This tends to happen when
490
raise NotVersionedError(path=f)
491
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
493
# having remove it, it must be either ignored or unknown
494
if self.is_ignored(f):
498
show_status(new_status, inv[fid].kind, quotefn(f))
501
self.branch._write_inventory(inv)
504
"""See Branch.unlock.
506
WorkingTree locking just uses the Branch locking facilities.
507
This is current because all working trees have an embedded branch
508
within them. IF in the future, we were to make branch data shareable
509
between multiple working trees, i.e. via shared storage, then we
510
would probably want to lock both the local tree, and the branch.
512
return self.branch.unlock()
515
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
516
def get_conflicted_stem(path):
517
for suffix in CONFLICT_SUFFIXES:
518
if path.endswith(suffix):
519
return path[:-len(suffix)]
added
removed
bzrlib/workingtree.py
