23
25
from inventory import Inventory
24
26
from trace import mutter, note
25
from tree import Tree, EmptyTree, RevisionTree
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
26
28
from inventory import InventoryEntry, Inventory
27
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
28
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
29
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
30
32
from store import ImmutableStore
31
33
from revision import Revision
32
from errors import BzrError
34
from errors import bailout, BzrError
33
35
from textui import show_status
36
from diff import diff_trees
35
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
36
39
## TODO: Maybe include checks for common corruption of newlines, etc?
165
132
__repr__ = __str__
170
from warnings import warn
171
warn("branch %r was not explicitly unlocked" % self)
175
def lock(self, mode):
177
if mode == 'w' and cur_lm == 'r':
178
raise BzrError("can't upgrade to a write lock")
136
def lock(self, mode='w'):
137
"""Lock the on-disk branch, excluding other processes."""
143
om = os.O_WRONLY | os.O_CREAT
148
raise BzrError("invalid locking mode %r" % mode)
151
lockfile = os.open(self.controlfilename('branch-lock'), om)
153
if e.errno == errno.ENOENT:
154
# might not exist on branches from <0.0.4
155
self.controlfile('branch-lock', 'w').close()
156
lockfile = os.open(self.controlfilename('branch-lock'), om)
180
assert self._lock_count >= 1
181
self._lock_count += 1
183
from bzrlib.lock import lock, LOCK_SH, LOCK_EX
189
raise ValueError('invalid lock mode %r' % mode)
191
lock(self._lockfile, m)
192
self._lock_mode = mode
197
if not self._lock_mode:
198
raise BzrError('branch %r is not locked' % (self))
200
if self._lock_count > 1:
201
self._lock_count -= 1
203
assert self._lock_count == 1
204
from bzrlib.lock import unlock
205
unlock(self._lockfile)
206
self._lock_mode = self._lock_count = None
160
fcntl.lockf(lockfile, lm)
162
fcntl.lockf(lockfile, fcntl.LOCK_UN)
164
self._lockmode = None
166
self._lockmode = mode
168
warning("please write a locking method for platform %r" % sys.platform)
170
self._lockmode = None
172
self._lockmode = mode
175
def _need_readlock(self):
176
if self._lockmode not in ['r', 'w']:
177
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
179
def _need_writelock(self):
180
if self._lockmode not in ['w']:
181
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
209
184
def abspath(self, name):
350
323
TODO: Adding a directory should optionally recurse down and
351
324
add all non-ignored children. Perhaps do that in a
352
325
higher-level method.
327
>>> b = ScratchBranch(files=['foo'])
328
>>> 'foo' in b.unknowns()
333
>>> 'foo' in b.unknowns()
335
>>> bool(b.inventory.path2id('foo'))
341
Traceback (most recent call last):
343
BzrError: ('foo is already versioned', [])
345
>>> b.add(['nothere'])
346
Traceback (most recent call last):
347
BzrError: ('cannot add: not a regular file or directory: nothere', [])
349
self._need_writelock()
354
351
# TODO: Re-adding a file that is removed in the working copy
355
352
# should probably put it back with the previous ID.
356
353
if isinstance(files, types.StringTypes):
357
assert(ids is None or isinstance(ids, types.StringTypes))
363
ids = [None] * len(files)
365
assert(len(ids) == len(files))
367
356
inv = self.read_working_inventory()
368
for f,file_id in zip(files, ids):
369
358
if is_control_file(f):
370
raise BzrError("cannot add control file %s" % quotefn(f))
359
bailout("cannot add control file %s" % quotefn(f))
372
361
fp = splitpath(f)
375
raise BzrError("cannot add top-level %r" % f)
364
bailout("cannot add top-level %r" % f)
377
366
fullpath = os.path.normpath(self.abspath(f))
380
369
kind = file_kind(fullpath)
382
371
# maybe something better?
383
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
372
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
385
374
if kind != 'file' and kind != 'directory':
386
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
375
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
389
file_id = gen_file_id(f)
377
file_id = gen_file_id(f)
390
378
inv.add_path(f, kind=kind, file_id=file_id)
393
381
show_status('A', kind, quotefn(f))
395
383
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
397
385
self._write_inventory(inv)
400
388
def print_file(self, file, revno):
401
389
"""Print `file` to stdout."""
390
self._need_readlock()
402
391
tree = self.revision_tree(self.lookup_revision(revno))
403
392
# use inventory as it was in that revision
404
393
file_id = tree.inventory.path2id(file)
406
raise BzrError("%r is not present in revision %d" % (file, revno))
395
bailout("%r is not present in revision %d" % (file, revno))
407
396
tree.print_file(file_id)
411
399
def remove(self, files, verbose=False):
412
400
"""Mark nominated files for removal from the inventory.
477
479
return self.working_tree().unknowns()
482
def commit(self, message, timestamp=None, timezone=None,
485
"""Commit working copy as a new revision.
487
The basic approach is to add all the file texts into the
488
store, then the inventory, then make a new revision pointing
489
to that inventory and store that.
491
This is not quite safe if the working copy changes during the
492
commit; for the moment that is simply not allowed. A better
493
approach is to make a temporary copy of the files before
494
computing their hashes, and then add those hashes in turn to
495
the inventory. This should mean at least that there are no
496
broken hash pointers. There is no way we can get a snapshot
497
of the whole directory at an instant. This would also have to
498
be robust against files disappearing, moving, etc. So the
499
whole thing is a bit hard.
501
timestamp -- if not None, seconds-since-epoch for a
502
postdated/predated commit.
504
self._need_writelock()
506
## TODO: Show branch names
508
# TODO: Don't commit if there are no changes, unless forced?
510
# First walk over the working inventory; and both update that
511
# and also build a new revision inventory. The revision
512
# inventory needs to hold the text-id, sha1 and size of the
513
# actual file versions committed in the revision. (These are
514
# not present in the working inventory.) We also need to
515
# detect missing/deleted files, and remove them from the
518
work_inv = self.read_working_inventory()
520
basis = self.basis_tree()
521
basis_inv = basis.inventory
523
for path, entry in work_inv.iter_entries():
524
## TODO: Cope with files that have gone missing.
526
## TODO: Check that the file kind has not changed from the previous
527
## revision of this file (if any).
531
p = self.abspath(path)
532
file_id = entry.file_id
533
mutter('commit prep file %s, id %r ' % (p, file_id))
535
if not os.path.exists(p):
536
mutter(" file is missing, removing from inventory")
538
show_status('D', entry.kind, quotefn(path))
539
missing_ids.append(file_id)
542
# TODO: Handle files that have been deleted
544
# TODO: Maybe a special case for empty files? Seems a
545
# waste to store them many times.
549
if basis_inv.has_id(file_id):
550
old_kind = basis_inv[file_id].kind
551
if old_kind != entry.kind:
552
bailout("entry %r changed kind from %r to %r"
553
% (file_id, old_kind, entry.kind))
555
if entry.kind == 'directory':
557
bailout("%s is entered as directory but not a directory" % quotefn(p))
558
elif entry.kind == 'file':
560
bailout("%s is entered as file but is not a file" % quotefn(p))
562
content = file(p, 'rb').read()
564
entry.text_sha1 = sha_string(content)
565
entry.text_size = len(content)
567
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
569
and (old_ie.text_size == entry.text_size)
570
and (old_ie.text_sha1 == entry.text_sha1)):
571
## assert content == basis.get_file(file_id).read()
572
entry.text_id = basis_inv[file_id].text_id
573
mutter(' unchanged from previous text_id {%s}' %
577
entry.text_id = gen_file_id(entry.name)
578
self.text_store.add(content, entry.text_id)
579
mutter(' stored with text_id {%s}' % entry.text_id)
583
elif (old_ie.name == entry.name
584
and old_ie.parent_id == entry.parent_id):
589
show_status(state, entry.kind, quotefn(path))
591
for file_id in missing_ids:
592
# have to do this later so we don't mess up the iterator.
593
# since parents may be removed before their children we
596
# FIXME: There's probably a better way to do this; perhaps
597
# the workingtree should know how to filter itself.
598
if work_inv.has_id(file_id):
599
del work_inv[file_id]
602
inv_id = rev_id = _gen_revision_id(time.time())
604
inv_tmp = tempfile.TemporaryFile()
605
inv.write_xml(inv_tmp)
607
self.inventory_store.add(inv_tmp, inv_id)
608
mutter('new inventory_id is {%s}' % inv_id)
610
self._write_inventory(work_inv)
612
if timestamp == None:
613
timestamp = time.time()
615
if committer == None:
616
committer = username()
619
timezone = local_time_offset()
621
mutter("building commit log message")
622
rev = Revision(timestamp=timestamp,
625
precursor = self.last_patch(),
630
rev_tmp = tempfile.TemporaryFile()
631
rev.write_xml(rev_tmp)
633
self.revision_store.add(rev_tmp, rev_id)
634
mutter("new revision_id is {%s}" % rev_id)
636
## XXX: Everything up to here can simply be orphaned if we abort
637
## the commit; it will leave junk files behind but that doesn't
640
## TODO: Read back the just-generated changeset, and make sure it
641
## applies and recreates the right state.
643
## TODO: Also calculate and store the inventory SHA1
644
mutter("committing patch r%d" % (self.revno() + 1))
647
self.append_revision(rev_id)
650
note("commited r%d" % self.revno())
480
653
def append_revision(self, revision_id):
481
654
mutter("add {%s} to revision-history" % revision_id)
482
655
rev_history = self.revision_history()
627
814
def rename_one(self, from_rel, to_rel):
628
815
"""Rename one file.
630
817
This can change the directory or the filename or both.
819
self._need_writelock()
632
820
tree = self.working_tree()
633
821
inv = tree.inventory
634
822
if not tree.has_filename(from_rel):
635
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
823
bailout("can't rename: old working file %r does not exist" % from_rel)
636
824
if tree.has_filename(to_rel):
637
raise BzrError("can't rename: new working file %r already exists" % to_rel)
825
bailout("can't rename: new working file %r already exists" % to_rel)
639
827
file_id = inv.path2id(from_rel)
640
828
if file_id == None:
641
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
829
bailout("can't rename: old name %r is not versioned" % from_rel)
643
831
if inv.path2id(to_rel):
644
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
832
bailout("can't rename: new name %r is already versioned" % to_rel)
646
834
to_dir, to_tail = os.path.split(to_rel)
647
835
to_dir_id = inv.path2id(to_dir)
648
836
if to_dir_id == None and to_dir != '':
649
raise BzrError("can't determine destination directory id for %r" % to_dir)
837
bailout("can't determine destination directory id for %r" % to_dir)
651
839
mutter("rename_one:")
652
840
mutter(" file_id {%s}" % file_id)
684
871
Note that to_name is only the last component of the new name;
685
872
this doesn't change the directory.
874
self._need_writelock()
687
875
## TODO: Option to move IDs only
688
876
assert not isinstance(from_paths, basestring)
689
877
tree = self.working_tree()
690
878
inv = tree.inventory
691
879
to_abs = self.abspath(to_name)
692
880
if not isdir(to_abs):
693
raise BzrError("destination %r is not a directory" % to_abs)
881
bailout("destination %r is not a directory" % to_abs)
694
882
if not tree.has_filename(to_name):
695
raise BzrError("destination %r not in working directory" % to_abs)
883
bailout("destination %r not in working directory" % to_abs)
696
884
to_dir_id = inv.path2id(to_name)
697
885
if to_dir_id == None and to_name != '':
698
raise BzrError("destination %r is not a versioned directory" % to_name)
886
bailout("destination %r is not a versioned directory" % to_name)
699
887
to_dir_ie = inv[to_dir_id]
700
888
if to_dir_ie.kind not in ('directory', 'root_directory'):
701
raise BzrError("destination %r is not a directory" % to_abs)
889
bailout("destination %r is not a directory" % to_abs)
703
to_idpath = inv.get_idpath(to_dir_id)
891
to_idpath = Set(inv.get_idpath(to_dir_id))
705
893
for f in from_paths:
706
894
if not tree.has_filename(f):
707
raise BzrError("%r does not exist in working tree" % f)
895
bailout("%r does not exist in working tree" % f)
708
896
f_id = inv.path2id(f)
710
raise BzrError("%r is not versioned" % f)
898
bailout("%r is not versioned" % f)
711
899
name_tail = splitpath(f)[-1]
712
900
dest_path = appendpath(to_name, name_tail)
713
901
if tree.has_filename(dest_path):
714
raise BzrError("destination %r already exists" % dest_path)
902
bailout("destination %r already exists" % dest_path)
715
903
if f_id in to_idpath:
716
raise BzrError("can't move %r to a subdirectory of itself" % f)
904
bailout("can't move %r to a subdirectory of itself" % f)
718
906
# OK, so there's a race here, it's possible that someone will
719
907
# create a file in this interval and then the rename might be
728
916
os.rename(self.abspath(f), self.abspath(dest_path))
729
917
except OSError, e:
730
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
918
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
731
919
["rename rolled back"])
733
921
self._write_inventory(inv)
925
def show_status(self, show_all=False, file_list=None):
926
"""Display single-line status for non-ignored working files.
928
The list is show sorted in order by file name.
930
>>> b = ScratchBranch(files=['foo', 'foo~'])
936
>>> b.commit("add foo")
938
>>> os.unlink(b.abspath('foo'))
942
self._need_readlock()
944
# We have to build everything into a list first so that it can
945
# sorted by name, incorporating all the different sources.
947
# FIXME: Rather than getting things in random order and then sorting,
948
# just step through in order.
950
# Interesting case: the old ID for a file has been removed,
951
# but a new file has been created under that name.
953
old = self.basis_tree()
954
new = self.working_tree()
956
items = diff_trees(old, new)
957
# We want to filter out only if any file was provided in the file_list.
958
if isinstance(file_list, list) and len(file_list):
959
items = [item for item in items if item[3] in file_list]
961
for fs, fid, oldname, newname, kind in items:
963
show_status(fs, kind,
964
oldname + ' => ' + newname)
965
elif fs == 'A' or fs == 'M':
966
show_status(fs, kind, newname)
968
show_status(fs, kind, oldname)
971
show_status(fs, kind, newname)
974
show_status(fs, kind, newname)
976
show_status(fs, kind, newname)
978
bailout("weird file state %r" % ((fs, fid),))
738
982
class ScratchBranch(Branch):
739
983
"""Special test class: a branch that cleans up after itself.