14
14
# along with this program; if not, write to the Free Software
15
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.
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
19
35
# 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.
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
26
from errors import BzrCheckError
27
from trace import mutter
51
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath, relpath
52
from bzrlib.errors import BzrCheckError, NotVersionedError
53
from bzrlib.trace import mutter
55
class TreeEntry(object):
56
"""An entry that implements the minium interface used by commands.
58
This needs further inspection, it may be better to have
59
InventoryEntries without ids - though that seems wrong. For now,
60
this is a parallel hierarchy to InventoryEntry, and needs to become
61
one of several things: decorates to that hierarchy, children of, or
63
Another note is that these objects are currently only used when there is
64
no InventoryEntry available - i.e. for unversioned objects.
65
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
68
def __eq__(self, other):
69
# yes, this us ugly, TODO: best practice __eq__ style.
70
return (isinstance(other, TreeEntry)
71
and other.__class__ == self.__class__)
73
def kind_character(self):
77
class TreeDirectory(TreeEntry):
78
"""See TreeEntry. This is a directory in a working tree."""
80
def __eq__(self, other):
81
return (isinstance(other, TreeDirectory)
82
and other.__class__ == self.__class__)
84
def kind_character(self):
88
class TreeFile(TreeEntry):
89
"""See TreeEntry. This is a regular file in a working tree."""
91
def __eq__(self, other):
92
return (isinstance(other, TreeFile)
93
and other.__class__ == self.__class__)
95
def kind_character(self):
99
class TreeLink(TreeEntry):
100
"""See TreeEntry. This is a symlink in a working tree."""
102
def __eq__(self, other):
103
return (isinstance(other, TreeLink)
104
and other.__class__ == self.__class__)
106
def kind_character(self):
29
110
class WorkingTree(bzrlib.tree.Tree):
30
111
"""Working copy tree.
35
116
It is possible for a `WorkingTree` to have a filename which is
36
117
not listed in the Inventory and vice versa.
38
def __init__(self, basedir, inv):
120
def __init__(self, basedir, branch=None):
121
"""Construct a WorkingTree for basedir.
123
If the branch is not supplied, it is opened automatically.
124
If the branch is supplied, it must be the branch for this basedir.
125
(branch.base is not cross checked, because for remote branches that
126
would be meaningless).
39
128
from bzrlib.hashcache import HashCache
40
129
from bzrlib.trace import note, mutter
130
assert isinstance(basedir, basestring), \
131
"base directory %r is not a string" % basedir
133
branch = Branch.open(basedir)
134
assert isinstance(branch, Branch), \
135
"branch %r is not a Branch" % branch
136
self._inventory = branch.inventory
137
self.path2id = self._inventory.path2id
43
139
self.basedir = basedir
44
self.path2id = inv.path2id
46
141
# update the whole cache up front and write to disk if anything changed;
47
142
# in the future we might want to do this more selectively
80
175
def abspath(self, filename):
81
176
return os.path.join(self.basedir, filename)
178
def relpath(self, abspath):
179
"""Return the local path portion from a given absolute path."""
180
return relpath(self.basedir, abspath)
83
182
def has_filename(self, filename):
84
return os.path.exists(self.abspath(filename))
183
return bzrlib.osutils.lexists(self.abspath(filename))
86
185
def get_file(self, file_id):
87
186
return self.get_file_byname(self.id2path(file_id))
100
203
if not inv.has_id(file_id):
102
205
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
206
return bzrlib.osutils.lexists(self.abspath(path))
208
def has_or_had_id(self, file_id):
209
if file_id == self.inventory.root.file_id:
211
return self.inventory.has_id(file_id)
106
213
__contains__ = has_id
109
216
def get_file_size(self, file_id):
110
# is this still called?
111
raise NotImplementedError()
217
return os.path.getsize(self.id2abspath(file_id))
114
219
def get_file_sha1(self, file_id):
115
220
path = self._inventory.id2path(file_id)
116
221
return self._hashcache.get_sha1(path)
224
def is_executable(self, file_id):
226
return self._inventory[file_id].executable
228
path = self._inventory.id2path(file_id)
229
mode = os.lstat(self.abspath(path)).st_mode
230
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
232
def get_symlink_target(self, file_id):
233
return os.readlink(self.id2abspath(file_id))
119
235
def file_class(self, filename):
120
236
if self.path2id(filename):
b'\\ No newline at end of file'
424
def kind(self, file_id):
425
return file_kind(self.id2abspath(file_id))
428
"""See Branch.lock_read, and WorkingTree.unlock."""
429
return self.branch.lock_read()
431
def lock_write(self):
432
"""See Branch.lock_write, and WorkingTree.unlock."""
433
return self.branch.lock_write()
436
def remove(self, files, verbose=False):
437
"""Remove nominated files from the working inventory..
439
This does not remove their text. This does not run on XXX on what? RBC
441
TODO: Refuse to remove modified files unless --force is given?
443
TODO: Do something useful with directories.
445
TODO: Should this remove the text or not? Tough call; not
446
removing may be useful and the user can just use use rm, and
447
is the opposite of add. Removing it is consistent with most
448
other tools. Maybe an option.
450
## TODO: Normalize names
451
## TODO: Remove nested loops; better scalability
452
if isinstance(files, basestring):
457
# do this before any modifications
461
# TODO: Perhaps make this just a warning, and continue?
462
# This tends to happen when
463
raise NotVersionedError(path=f)
464
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
466
# having remove it, it must be either ignored or unknown
467
if self.is_ignored(f):
471
show_status(new_status, inv[fid].kind, quotefn(f))
474
self.branch._write_inventory(inv)
477
"""See Branch.unlock.
479
WorkingTree locking just uses the Branch locking facilities.
480
This is current because all working trees have an embedded branch
481
within them. IF in the future, we were to make branch data shareable
482
between multiple working trees, i.e. via shared storage, then we
483
would probably want to lock both the local tree, and the branch.
485
return self.branch.unlock()
488
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
489
def get_conflicted_stem(path):
490
for suffix in CONFLICT_SUFFIXES:
491
if path.endswith(suffix):
492
return path[:-len(suffix)]
added
removed
bzrlib/workingtree.py
