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
"""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.
45
from copy import deepcopy
50
from bzrlib.branch import (Branch,
55
from bzrlib.errors import (BzrCheckError,
58
WeaveRevisionNotPresent,
61
from bzrlib.inventory import InventoryEntry
62
from bzrlib.osutils import (appendpath,
76
from bzrlib.textui import show_status
78
from bzrlib.trace import mutter
82
def gen_file_id(name):
83
"""Return new file id.
85
This should probably generate proper UUIDs, but for the moment we
86
cope with just randomness because running uuidgen every time is
89
from binascii import hexlify
96
idx = name.rfind('\\')
100
# make it not a hidden file
101
name = name.lstrip('.')
103
# remove any wierd characters; we don't escape them but rather
105
name = re.sub(r'[^\w.]', '', name)
107
s = hexlify(rand_bytes(8))
108
return '-'.join((name, compact_date(time()), s))
112
"""Return a new tree-root file id."""
113
return gen_file_id('TREE_ROOT')
116
class TreeEntry(object):
117
"""An entry that implements the minium interface used by commands.
119
This needs further inspection, it may be better to have
120
InventoryEntries without ids - though that seems wrong. For now,
121
this is a parallel hierarchy to InventoryEntry, and needs to become
122
one of several things: decorates to that hierarchy, children of, or
124
Another note is that these objects are currently only used when there is
125
no InventoryEntry available - i.e. for unversioned objects.
126
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
129
def __eq__(self, other):
130
# yes, this us ugly, TODO: best practice __eq__ style.
131
return (isinstance(other, TreeEntry)
132
and other.__class__ == self.__class__)
134
def kind_character(self):
138
class TreeDirectory(TreeEntry):
139
"""See TreeEntry. This is a directory in a working tree."""
141
def __eq__(self, other):
142
return (isinstance(other, TreeDirectory)
143
and other.__class__ == self.__class__)
145
def kind_character(self):
149
class TreeFile(TreeEntry):
150
"""See TreeEntry. This is a regular file in a working tree."""
152
def __eq__(self, other):
153
return (isinstance(other, TreeFile)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class TreeLink(TreeEntry):
161
"""See TreeEntry. This is a symlink in a working tree."""
163
def __eq__(self, other):
164
return (isinstance(other, TreeLink)
165
and other.__class__ == self.__class__)
167
def kind_character(self):
21
from errors import BzrCheckError
22
from trace import mutter
171
25
class WorkingTree(bzrlib.tree.Tree):
172
26
"""Working copy tree.
177
31
It is possible for a `WorkingTree` to have a filename which is
178
32
not listed in the Inventory and vice versa.
181
def __init__(self, basedir=u'.', branch=None):
182
"""Construct a WorkingTree for basedir.
184
If the branch is not supplied, it is opened automatically.
185
If the branch is supplied, it must be the branch for this basedir.
186
(branch.base is not cross checked, because for remote branches that
187
would be meaningless).
189
from bzrlib.hashcache import HashCache
190
from bzrlib.trace import note, mutter
191
assert isinstance(basedir, basestring), \
192
"base directory %r is not a string" % basedir
194
branch = Branch.open(basedir)
195
assert isinstance(branch, Branch), \
196
"branch %r is not a Branch" % branch
198
self.basedir = realpath(basedir)
200
# update the whole cache up front and write to disk if anything changed;
201
# in the future we might want to do this more selectively
202
# two possible ways offer themselves : in self._unlock, write the cache
203
# if needed, or, when the cache sees a change, append it to the hash
204
# cache file, and have the parser take the most recent entry for a
206
hc = self._hashcache = HashCache(basedir)
214
self._set_inventory(self.read_working_inventory())
216
def _set_inventory(self, inv):
36
def __init__(self, basedir, inv):
217
37
self._inventory = inv
218
self.path2id = self._inventory.path2id
221
def open_containing(path=None):
222
"""Open an existing working tree which has its root about path.
224
This probes for a working tree at path and searches upwards from there.
226
Basically we keep looking up until we find the control directory or
227
run into /. If there isn't one, raises NotBranchError.
228
TODO: give this a new exception.
229
If there is one, it is returned, along with the unused portion of path.
235
if path.find('://') != -1:
236
raise NotBranchError(path=path)
241
return WorkingTree(path), tail
242
except NotBranchError:
245
tail = pathjoin(os.path.basename(path), tail)
247
tail = os.path.basename(path)
249
path = os.path.dirname(path)
251
# reached the root, whatever that may be
252
raise NotBranchError(path=path)
38
self.basedir = basedir
39
self.path2id = inv.path2id
40
self._update_statcache()
254
42
def __iter__(self):
255
43
"""Iterate through file_ids for this tree.
258
46
and the working file exists.
260
48
inv = self._inventory
261
for path, ie in inv.iter_entries():
262
if bzrlib.osutils.lexists(self.abspath(path)):
49
for file_id in self._inventory:
50
# TODO: This is slightly redundant; we should be able to just
51
# check the statcache but it only includes regular files.
52
# only include files which still exist on disk
55
if ((file_id in self._statcache)
56
or (os.path.exists(self.abspath(inv.id2path(file_id))))):
265
61
def __repr__(self):
266
62
return "<%s of %s>" % (self.__class__.__name__,
267
getattr(self, 'basedir', None))
269
65
def abspath(self, filename):
270
return pathjoin(self.basedir, filename)
272
def relpath(self, abs):
273
"""Return the local path portion from a given absolute path."""
274
return relpath(self.basedir, abs)
66
return os.path.join(self.basedir, filename)
276
68
def has_filename(self, filename):
277
return bzrlib.osutils.lexists(self.abspath(filename))
69
return os.path.exists(self.abspath(filename))
279
71
def get_file(self, file_id):
280
72
return self.get_file_byname(self.id2path(file_id))
282
74
def get_file_byname(self, filename):
283
75
return file(self.abspath(filename), 'rb')
285
def get_root_id(self):
286
"""Return the id of this trees root"""
287
inv = self.read_working_inventory()
288
return inv.root.file_id
290
77
def _get_store_filename(self, file_id):
291
## XXX: badly named; this is not in the store at all
292
return self.abspath(self.id2path(file_id))
295
def commit(self, *args, **kw):
296
from bzrlib.commit import Commit
297
Commit().commit(self.branch, *args, **kw)
298
self._set_inventory(self.read_working_inventory())
300
def id2abspath(self, file_id):
301
return self.abspath(self.id2path(file_id))
78
## XXX: badly named; this isn't in the store at all
79
return self.abspath(self.id2path(file_id))
303
82
def has_id(self, file_id):
304
83
# files that have been deleted are excluded
305
inv = self._inventory
306
if not inv.has_id(file_id):
84
if not self.inventory.has_id(file_id):
308
path = inv.id2path(file_id)
309
return bzrlib.osutils.lexists(self.abspath(path))
311
def has_or_had_id(self, file_id):
312
if file_id == self.inventory.root.file_id:
86
if file_id in self._statcache:
314
return self.inventory.has_id(file_id)
88
return os.path.exists(self.abspath(self.id2path(file_id)))
316
91
__contains__ = has_id
94
def _update_statcache(self):
96
if not self._statcache:
97
self._statcache = statcache.update_cache(self.basedir, self.inventory)
318
99
def get_file_size(self, file_id):
319
return os.path.getsize(self.id2abspath(file_id))
101
return os.stat(self._get_store_filename(file_id))[stat.ST_SIZE]
322
104
def get_file_sha1(self, file_id):
323
path = self._inventory.id2path(file_id)
324
return self._hashcache.get_sha1(path)
326
def is_executable(self, file_id):
328
return self._inventory[file_id].executable
330
path = self._inventory.id2path(file_id)
331
mode = os.lstat(self.abspath(path)).st_mode
332
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
335
def add(self, files, ids=None):
336
"""Make files versioned.
338
Note that the command line normally calls smart_add instead,
339
which can automatically recurse.
341
This adds the files to the inventory, so that they will be
342
recorded by the next commit.
345
List of paths to add, relative to the base of the tree.
348
If set, use these instead of automatically generated ids.
349
Must be the same length as the list of files, but may
350
contain None for ids that are to be autogenerated.
352
TODO: Perhaps have an option to add the ids even if the files do
355
TODO: Perhaps callback with the ids and paths as they're added.
357
# TODO: Re-adding a file that is removed in the working copy
358
# should probably put it back with the previous ID.
359
if isinstance(files, basestring):
360
assert(ids is None or isinstance(ids, basestring))
366
ids = [None] * len(files)
368
assert(len(ids) == len(files))
370
inv = self.read_working_inventory()
371
for f,file_id in zip(files, ids):
372
if is_control_file(f):
373
raise BzrError("cannot add control file %s" % quotefn(f))
378
raise BzrError("cannot add top-level %r" % f)
380
fullpath = normpath(self.abspath(f))
383
kind = file_kind(fullpath)
385
# maybe something better?
386
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
388
if not InventoryEntry.versionable_kind(kind):
389
raise BzrError('cannot add: not a versionable file ('
390
'i.e. regular file, symlink or directory): %s' % quotefn(f))
393
file_id = gen_file_id(f)
394
inv.add_path(f, kind=kind, file_id=file_id)
396
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
397
self._write_inventory(inv)
400
def add_pending_merge(self, *revision_ids):
401
# TODO: Perhaps should check at this point that the
402
# history of the revision is actually present?
403
p = self.pending_merges()
405
for rev_id in revision_ids:
411
self.set_pending_merges(p)
413
def pending_merges(self):
414
"""Return a list of pending merges.
416
These are revisions that have been merged into the working
417
directory but not yet committed.
419
cfn = self.branch._rel_controlfilename('pending-merges')
420
if not self.branch._transport.has(cfn):
423
for l in self.branch.controlfile('pending-merges', 'r').readlines():
424
p.append(l.rstrip('\n'))
428
def set_pending_merges(self, rev_list):
429
self.branch.put_controlfile('pending-merges', '\n'.join(rev_list))
431
def get_symlink_target(self, file_id):
432
return os.readlink(self.id2abspath(file_id))
105
return self._statcache[file_id][statcache.SC_SHA1]
434
108
def file_class(self, filename):
435
109
if self.path2id(filename):
509
173
for ff in descend(fp, f_ie.file_id, fap):
512
for f in descend(u'', inv.root.file_id, self.basedir):
176
for f in descend('', inv.root.file_id, self.basedir):
516
def move(self, from_paths, to_name):
519
to_name must exist in the inventory.
521
If to_name exists and is a directory, the files are moved into
522
it, keeping their old names.
524
Note that to_name is only the last component of the new name;
525
this doesn't change the directory.
527
This returns a list of (from_path, to_path) pairs for each
531
## TODO: Option to move IDs only
532
assert not isinstance(from_paths, basestring)
534
to_abs = self.abspath(to_name)
535
if not isdir(to_abs):
536
raise BzrError("destination %r is not a directory" % to_abs)
537
if not self.has_filename(to_name):
538
raise BzrError("destination %r not in working directory" % to_abs)
539
to_dir_id = inv.path2id(to_name)
540
if to_dir_id == None and to_name != '':
541
raise BzrError("destination %r is not a versioned directory" % to_name)
542
to_dir_ie = inv[to_dir_id]
543
if to_dir_ie.kind not in ('directory', 'root_directory'):
544
raise BzrError("destination %r is not a directory" % to_abs)
546
to_idpath = inv.get_idpath(to_dir_id)
549
if not self.has_filename(f):
550
raise BzrError("%r does not exist in working tree" % f)
551
f_id = inv.path2id(f)
553
raise BzrError("%r is not versioned" % f)
554
name_tail = splitpath(f)[-1]
555
dest_path = appendpath(to_name, name_tail)
556
if self.has_filename(dest_path):
557
raise BzrError("destination %r already exists" % dest_path)
558
if f_id in to_idpath:
559
raise BzrError("can't move %r to a subdirectory of itself" % f)
561
# OK, so there's a race here, it's possible that someone will
562
# create a file in this interval and then the rename might be
563
# left half-done. But we should have caught most problems.
564
orig_inv = deepcopy(self.inventory)
567
name_tail = splitpath(f)[-1]
568
dest_path = appendpath(to_name, name_tail)
569
result.append((f, dest_path))
570
inv.rename(inv.path2id(f), to_dir_id, name_tail)
572
rename(self.abspath(f), self.abspath(dest_path))
574
raise BzrError("failed to rename %r to %r: %s" %
575
(f, dest_path, e[1]),
576
["rename rolled back"])
578
# restore the inventory on error
579
self._set_inventory(orig_inv)
581
self._write_inventory(inv)
585
def rename_one(self, from_rel, to_rel):
588
This can change the directory or the filename or both.
591
if not self.has_filename(from_rel):
592
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
593
if self.has_filename(to_rel):
594
raise BzrError("can't rename: new working file %r already exists" % to_rel)
596
file_id = inv.path2id(from_rel)
598
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
601
from_parent = entry.parent_id
602
from_name = entry.name
604
if inv.path2id(to_rel):
605
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
607
to_dir, to_tail = os.path.split(to_rel)
608
to_dir_id = inv.path2id(to_dir)
609
if to_dir_id == None and to_dir != '':
610
raise BzrError("can't determine destination directory id for %r" % to_dir)
612
mutter("rename_one:")
613
mutter(" file_id {%s}" % file_id)
614
mutter(" from_rel %r" % from_rel)
615
mutter(" to_rel %r" % to_rel)
616
mutter(" to_dir %r" % to_dir)
617
mutter(" to_dir_id {%s}" % to_dir_id)
619
inv.rename(file_id, to_dir_id, to_tail)
621
from_abs = self.abspath(from_rel)
622
to_abs = self.abspath(to_rel)
624
rename(from_abs, to_abs)
626
inv.rename(file_id, from_parent, from_name)
627
raise BzrError("failed to rename %r to %r: %s"
628
% (from_abs, to_abs, e[1]),
629
["rename rolled back"])
630
self._write_inventory(inv)
633
181
def unknowns(self):
634
"""Return all unknown files.
636
These are files in the working directory that are not versioned or
637
control files or ignored.
639
>>> from bzrlib.branch import ScratchBranch
640
>>> b = ScratchBranch(files=['foo', 'foo~'])
641
>>> tree = WorkingTree(b.base, b)
642
>>> map(str, tree.unknowns())
645
>>> list(b.unknowns())
647
>>> tree.remove('foo')
648
>>> list(b.unknowns())
651
182
for subp in self.extras():
652
183
if not self.is_ignored(subp):
655
def iter_conflicts(self):
657
for path in (s[0] for s in self.list_files()):
658
stem = get_conflicted_stem(path)
661
if stem not in conflicted:
666
def pull(self, source, overwrite=False):
667
from bzrlib.merge import merge_inner
670
old_revision_history = self.branch.revision_history()
671
count = self.branch.pull(source, overwrite)
672
new_revision_history = self.branch.revision_history()
673
if new_revision_history != old_revision_history:
674
if len(old_revision_history):
675
other_revision = old_revision_history[-1]
677
other_revision = None
678
merge_inner(self.branch,
679
self.branch.basis_tree(),
680
self.branch.revision_tree(other_revision))
685
187
def extras(self):
686
188
"""Yield all unknown files in this WorkingTree.
776
def kind(self, file_id):
777
return file_kind(self.id2abspath(file_id))
780
"""See Branch.lock_read, and WorkingTree.unlock."""
781
return self.branch.lock_read()
783
def lock_write(self):
784
"""See Branch.lock_write, and WorkingTree.unlock."""
785
return self.branch.lock_write()
787
def _basis_inventory_name(self, revision_id):
788
return 'basis-inventory.%s' % revision_id
790
def set_last_revision(self, new_revision, old_revision=None):
793
path = self._basis_inventory_name(old_revision)
794
path = self.branch._rel_controlfilename(path)
795
self.branch._transport.delete(path)
799
xml = self.branch.get_inventory_xml(new_revision)
800
path = self._basis_inventory_name(new_revision)
801
self.branch.put_controlfile(path, xml)
802
except WeaveRevisionNotPresent:
805
def read_basis_inventory(self, revision_id):
806
"""Read the cached basis inventory."""
807
path = self._basis_inventory_name(revision_id)
808
return self.branch.controlfile(path, 'r').read()
811
def read_working_inventory(self):
812
"""Read the working inventory."""
813
# ElementTree does its own conversion from UTF-8, so open in
815
f = self.branch.controlfile('inventory', 'rb')
816
return bzrlib.xml5.serializer_v5.read_inventory(f)
819
def remove(self, files, verbose=False):
820
"""Remove nominated files from the working inventory..
822
This does not remove their text. This does not run on XXX on what? RBC
824
TODO: Refuse to remove modified files unless --force is given?
826
TODO: Do something useful with directories.
828
TODO: Should this remove the text or not? Tough call; not
829
removing may be useful and the user can just use use rm, and
830
is the opposite of add. Removing it is consistent with most
831
other tools. Maybe an option.
833
## TODO: Normalize names
834
## TODO: Remove nested loops; better scalability
835
if isinstance(files, basestring):
840
# do this before any modifications
844
# TODO: Perhaps make this just a warning, and continue?
845
# This tends to happen when
846
raise NotVersionedError(path=f)
847
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
849
# having remove it, it must be either ignored or unknown
850
if self.is_ignored(f):
854
show_status(new_status, inv[fid].kind, quotefn(f))
857
self._write_inventory(inv)
860
def revert(self, filenames, old_tree=None, backups=True):
861
from bzrlib.merge import merge_inner
863
old_tree = self.branch.basis_tree()
864
merge_inner(self.branch, old_tree,
865
self, ignore_zero=True,
866
backup_files=backups,
867
interesting_files=filenames)
868
if not len(filenames):
869
self.set_pending_merges([])
872
def set_inventory(self, new_inventory_list):
873
from bzrlib.inventory import (Inventory,
878
inv = Inventory(self.get_root_id())
879
for path, file_id, parent, kind in new_inventory_list:
880
name = os.path.basename(path)
883
# fixme, there should be a factory function inv,add_??
884
if kind == 'directory':
885
inv.add(InventoryDirectory(file_id, name, parent))
887
inv.add(InventoryFile(file_id, name, parent))
888
elif kind == 'symlink':
889
inv.add(InventoryLink(file_id, name, parent))
891
raise BzrError("unknown kind %r" % kind)
892
self._write_inventory(inv)
895
def set_root_id(self, file_id):
896
"""Set the root id for this tree."""
897
inv = self.read_working_inventory()
898
orig_root_id = inv.root.file_id
899
del inv._byid[inv.root.file_id]
900
inv.root.file_id = file_id
901
inv._byid[inv.root.file_id] = inv.root
904
if entry.parent_id in (None, orig_root_id):
905
entry.parent_id = inv.root.file_id
906
self._write_inventory(inv)
909
"""See Branch.unlock.
911
WorkingTree locking just uses the Branch locking facilities.
912
This is current because all working trees have an embedded branch
913
within them. IF in the future, we were to make branch data shareable
914
between multiple working trees, i.e. via shared storage, then we
915
would probably want to lock both the local tree, and the branch.
917
if self._hashcache.needs_write:
918
self._hashcache.write()
919
return self.branch.unlock()
922
def _write_inventory(self, inv):
923
"""Write inventory as the current inventory."""
924
from cStringIO import StringIO
925
from bzrlib.atomicfile import AtomicFile
927
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
929
f = AtomicFile(self.branch.controlfilename('inventory'))
935
self._set_inventory(inv)
936
mutter('wrote working inventory')
939
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
940
def get_conflicted_stem(path):
941
for suffix in CONFLICT_SUFFIXES:
942
if path.endswith(suffix):
943
return path[:-len(suffix)]
added
removed
bzrlib/workingtree.py
