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
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
sha_file, appendpath, file_kind
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
42
# TODO: Some operations like log might retrieve the same revisions
43
# repeatedly to calculate deltas. We could perhaps have a weakref
44
# cache in memory to make this faster.
46
# TODO: please move the revision-string syntax stuff out of the branch
47
# object; it's clutter
50
def find_branch(f, **args):
51
if f and (f.startswith('http://') or f.startswith('https://')):
53
return remotebranch.RemoteBranch(f, **args)
55
return Branch(f, **args)
58
def find_cached_branch(f, cache_root, **args):
59
from remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from meta_store import CachedStore
63
cache_path = os.path.join(cache_root, store_name)
65
new_store = CachedStore(getattr(br, store_name), cache_path)
66
setattr(br, store_name, new_store)
68
if isinstance(br, RemoteBranch):
69
cacheify(br, 'inventory_store')
70
cacheify(br, 'text_store')
71
cacheify(br, 'revision_store')
75
def _relpath(base, path):
76
"""Return path relative to base, or raise exception.
78
The path may be either an absolute path or a path relative to the
79
current working directory.
81
Lifted out of Branch.relpath for ease of testing.
83
os.path.commonprefix (python2.4) has a bad bug that it works just
84
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
85
avoids that problem."""
86
rp = os.path.abspath(path)
90
while len(head) >= len(base):
93
head, tail = os.path.split(head)
97
from errors import NotBranchError
98
raise NotBranchError("path %r is not within branch %r" % (rp, base))
100
return os.sep.join(s)
103
def find_branch_root(f=None):
104
"""Find the branch root enclosing f, or pwd.
106
f may be a filename or a URL.
108
It is not necessary that f exists.
110
Basically we keep looking up until we find the control directory or
111
run into the root. If there isn't one, raises NotBranchError.
115
elif hasattr(os.path, 'realpath'):
116
f = os.path.realpath(f)
118
f = os.path.abspath(f)
119
if not os.path.exists(f):
120
raise BzrError('%r does not exist' % f)
126
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
128
head, tail = os.path.split(f)
130
# reached the root, whatever that may be
131
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
136
# XXX: move into bzrlib.errors; subclass BzrError
137
class DivergedBranches(Exception):
138
def __init__(self, branch1, branch2):
139
self.branch1 = branch1
140
self.branch2 = branch2
141
Exception.__init__(self, "These branches have diverged.")
144
######################################################################
147
class Branch(object):
148
"""Branch holding a history of revisions.
151
Base directory of the branch.
157
If _lock_mode is true, a positive count of the number of times the
161
Lock object from bzrlib.lock.
168
# Map some sort of prefix into a namespace
169
# stuff like "revno:10", "revid:", etc.
170
# This should match a prefix with a function which accepts
171
REVISION_NAMESPACES = {}
173
def __init__(self, base, init=False, find_root=True):
174
"""Create new branch object at a particular location.
176
base -- Base directory for the branch.
178
init -- If True, create new control files in a previously
179
unversioned directory. If False, the branch must already
182
find_root -- If true and init is false, find the root of the
183
existing branch containing base.
185
In the test suite, creation of new trees is tested using the
186
`ScratchBranch` class.
188
from bzrlib.store import ImmutableStore
190
self.base = os.path.realpath(base)
193
self.base = find_branch_root(base)
195
self.base = os.path.realpath(base)
196
if not isdir(self.controlfilename('.')):
197
from errors import NotBranchError
198
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
199
['use "bzr init" to initialize a new working tree',
200
'current bzr can only operate from top-of-tree'])
203
self.text_store = ImmutableStore(self.controlfilename('text-store'))
204
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
205
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
209
return '%s(%r)' % (self.__class__.__name__, self.base)
216
if self._lock_mode or self._lock:
217
from warnings import warn
218
warn("branch %r was not explicitly unlocked" % self)
222
def lock_write(self):
224
if self._lock_mode != 'w':
225
from errors import LockError
226
raise LockError("can't upgrade to a write lock from %r" %
228
self._lock_count += 1
230
from bzrlib.lock import WriteLock
232
self._lock = WriteLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'w'
239
assert self._lock_mode in ('r', 'w'), \
240
"invalid lock mode %r" % self._lock_mode
241
self._lock_count += 1
243
from bzrlib.lock import ReadLock
245
self._lock = ReadLock(self.controlfilename('branch-lock'))
246
self._lock_mode = 'r'
250
if not self._lock_mode:
251
from errors import LockError
252
raise LockError('branch %r is not locked' % (self))
254
if self._lock_count > 1:
255
self._lock_count -= 1
259
self._lock_mode = self._lock_count = None
261
def abspath(self, name):
262
"""Return absolute filename for something in the branch"""
263
return os.path.join(self.base, name)
265
def relpath(self, path):
266
"""Return path relative to this branch of something inside it.
268
Raises an error if path is not in this branch."""
269
return _relpath(self.base, path)
271
def controlfilename(self, file_or_path):
272
"""Return location relative to branch."""
273
if isinstance(file_or_path, basestring):
274
file_or_path = [file_or_path]
275
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
278
def controlfile(self, file_or_path, mode='r'):
279
"""Open a control file for this branch.
281
There are two classes of file in the control directory: text
282
and binary. binary files are untranslated byte streams. Text
283
control files are stored with Unix newlines and in UTF-8, even
284
if the platform or locale defaults are different.
286
Controlfiles should almost never be opened in write mode but
287
rather should be atomically copied and replaced using atomicfile.
290
fn = self.controlfilename(file_or_path)
292
if mode == 'rb' or mode == 'wb':
293
return file(fn, mode)
294
elif mode == 'r' or mode == 'w':
295
# open in binary mode anyhow so there's no newline translation;
296
# codecs uses line buffering by default; don't want that.
298
return codecs.open(fn, mode + 'b', 'utf-8',
301
raise BzrError("invalid controlfile mode %r" % mode)
303
def _make_control(self):
304
from bzrlib.inventory import Inventory
306
os.mkdir(self.controlfilename([]))
307
self.controlfile('README', 'w').write(
308
"This is a Bazaar-NG control directory.\n"
309
"Do not change any files in this directory.\n")
310
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
311
for d in ('text-store', 'inventory-store', 'revision-store'):
312
os.mkdir(self.controlfilename(d))
313
for f in ('revision-history', 'merged-patches',
314
'pending-merged-patches', 'branch-name',
317
self.controlfile(f, 'w').write('')
318
mutter('created control directory in ' + self.base)
320
# if we want per-tree root ids then this is the place to set
321
# them; they're not needed for now and so ommitted for
323
f = self.controlfile('inventory','w')
324
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
327
def _check_format(self):
328
"""Check this branch format is supported.
330
The current tool only supports the current unstable format.
332
In the future, we might need different in-memory Branch
333
classes to support downlevel branches. But not yet.
335
# This ignores newlines so that we can open branches created
336
# on Windows from Linux and so on. I think it might be better
337
# to always make all internal files in unix format.
338
fmt = self.controlfile('branch-format', 'r').read()
339
fmt = fmt.replace('\r\n', '\n')
340
if fmt != BZR_BRANCH_FORMAT:
341
raise BzrError('sorry, branch format %r not supported' % fmt,
342
['use a different bzr version',
343
'or remove the .bzr directory and "bzr init" again'])
345
def get_root_id(self):
346
"""Return the id of this branches root"""
347
inv = self.read_working_inventory()
348
return inv.root.file_id
350
def set_root_id(self, file_id):
351
inv = self.read_working_inventory()
352
orig_root_id = inv.root.file_id
353
del inv._byid[inv.root.file_id]
354
inv.root.file_id = file_id
355
inv._byid[inv.root.file_id] = inv.root
358
if entry.parent_id in (None, orig_root_id):
359
entry.parent_id = inv.root.file_id
360
self._write_inventory(inv)
362
def read_working_inventory(self):
363
"""Read the working inventory."""
364
from bzrlib.inventory import Inventory
367
# ElementTree does its own conversion from UTF-8, so open in
369
f = self.controlfile('inventory', 'rb')
370
return bzrlib.xml.serializer_v4.read_inventory(f)
375
def _write_inventory(self, inv):
376
"""Update the working inventory.
378
That is to say, the inventory describing changes underway, that
379
will be committed to the next revision.
381
from bzrlib.atomicfile import AtomicFile
385
f = AtomicFile(self.controlfilename('inventory'), 'wb')
387
bzrlib.xml.serializer_v4.write_inventory(inv, f)
394
mutter('wrote working inventory')
397
inventory = property(read_working_inventory, _write_inventory, None,
398
"""Inventory for the working copy.""")
401
def add(self, files, ids=None):
402
"""Make files versioned.
404
Note that the command line normally calls smart_add instead,
405
which can automatically recurse.
407
This puts the files in the Added state, so that they will be
408
recorded by the next commit.
411
List of paths to add, relative to the base of the tree.
414
If set, use these instead of automatically generated ids.
415
Must be the same length as the list of files, but may
416
contain None for ids that are to be autogenerated.
418
TODO: Perhaps have an option to add the ids even if the files do
421
TODO: Perhaps yield the ids and paths as they're added.
423
# TODO: Re-adding a file that is removed in the working copy
424
# should probably put it back with the previous ID.
425
if isinstance(files, basestring):
426
assert(ids is None or isinstance(ids, basestring))
432
ids = [None] * len(files)
434
assert(len(ids) == len(files))
438
inv = self.read_working_inventory()
439
for f,file_id in zip(files, ids):
440
if is_control_file(f):
441
raise BzrError("cannot add control file %s" % quotefn(f))
446
raise BzrError("cannot add top-level %r" % f)
448
fullpath = os.path.normpath(self.abspath(f))
451
kind = file_kind(fullpath)
453
# maybe something better?
454
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
456
if kind != 'file' and kind != 'directory':
457
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
460
file_id = gen_file_id(f)
461
inv.add_path(f, kind=kind, file_id=file_id)
463
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
465
self._write_inventory(inv)
470
def print_file(self, file, revno):
471
"""Print `file` to stdout."""
474
tree = self.revision_tree(self.lookup_revision(revno))
475
# use inventory as it was in that revision
476
file_id = tree.inventory.path2id(file)
478
raise BzrError("%r is not present in revision %s" % (file, revno))
479
tree.print_file(file_id)
484
def remove(self, files, verbose=False):
485
"""Mark nominated files for removal from the inventory.
487
This does not remove their text. This does not run on
489
TODO: Refuse to remove modified files unless --force is given?
491
TODO: Do something useful with directories.
493
TODO: Should this remove the text or not? Tough call; not
494
removing may be useful and the user can just use use rm, and
495
is the opposite of add. Removing it is consistent with most
496
other tools. Maybe an option.
498
## TODO: Normalize names
499
## TODO: Remove nested loops; better scalability
500
if isinstance(files, basestring):
506
tree = self.working_tree()
509
# do this before any modifications
513
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
514
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
516
# having remove it, it must be either ignored or unknown
517
if tree.is_ignored(f):
521
show_status(new_status, inv[fid].kind, quotefn(f))
524
self._write_inventory(inv)
529
# FIXME: this doesn't need to be a branch method
530
def set_inventory(self, new_inventory_list):
531
from bzrlib.inventory import Inventory, InventoryEntry
532
inv = Inventory(self.get_root_id())
533
for path, file_id, parent, kind in new_inventory_list:
534
name = os.path.basename(path)
537
inv.add(InventoryEntry(file_id, name, kind, parent))
538
self._write_inventory(inv)
542
"""Return all unknown files.
544
These are files in the working directory that are not versioned or
545
control files or ignored.
547
>>> b = ScratchBranch(files=['foo', 'foo~'])
548
>>> list(b.unknowns())
551
>>> list(b.unknowns())
554
>>> list(b.unknowns())
557
return self.working_tree().unknowns()
560
def append_revision(self, *revision_ids):
561
from bzrlib.atomicfile import AtomicFile
563
for revision_id in revision_ids:
564
mutter("add {%s} to revision-history" % revision_id)
566
rev_history = self.revision_history()
567
rev_history.extend(revision_ids)
569
f = AtomicFile(self.controlfilename('revision-history'))
571
for rev_id in rev_history:
578
def get_revision_xml_file(self, revision_id):
579
"""Return XML file object for revision object."""
580
if not revision_id or not isinstance(revision_id, basestring):
581
raise InvalidRevisionId(revision_id)
586
return self.revision_store[revision_id]
588
raise bzrlib.errors.NoSuchRevision(self, revision_id)
594
get_revision_xml = get_revision_xml_file
597
def get_revision(self, revision_id):
598
"""Return the Revision object for a named revision"""
599
xml_file = self.get_revision_xml_file(revision_id)
602
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
603
except SyntaxError, e:
604
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
608
assert r.revision_id == revision_id
612
def get_revision_delta(self, revno):
613
"""Return the delta for one revision.
615
The delta is relative to its mainline predecessor, or the
616
empty tree for revision 1.
618
assert isinstance(revno, int)
619
rh = self.revision_history()
620
if not (1 <= revno <= len(rh)):
621
raise InvalidRevisionNumber(revno)
623
# revno is 1-based; list is 0-based
625
new_tree = self.revision_tree(rh[revno-1])
627
old_tree = EmptyTree()
629
old_tree = self.revision_tree(rh[revno-2])
631
return compare_trees(old_tree, new_tree)
635
def get_revision_sha1(self, revision_id):
636
"""Hash the stored value of a revision, and return it."""
637
# In the future, revision entries will be signed. At that
638
# point, it is probably best *not* to include the signature
639
# in the revision hash. Because that lets you re-sign
640
# the revision, (add signatures/remove signatures) and still
641
# have all hash pointers stay consistent.
642
# But for now, just hash the contents.
643
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
646
def get_inventory(self, inventory_id):
647
"""Get Inventory object by hash.
649
TODO: Perhaps for this and similar methods, take a revision
650
parameter which can be either an integer revno or a
652
from bzrlib.inventory import Inventory
654
f = self.get_inventory_xml_file(inventory_id)
655
return bzrlib.xml.serializer_v4.read_inventory(f)
658
def get_inventory_xml(self, inventory_id):
659
"""Get inventory XML as a file object."""
660
return self.inventory_store[inventory_id]
662
get_inventory_xml_file = get_inventory_xml
665
def get_inventory_sha1(self, inventory_id):
666
"""Return the sha1 hash of the inventory entry
668
return sha_file(self.get_inventory_xml(inventory_id))
671
def get_revision_inventory(self, revision_id):
672
"""Return inventory of a past revision."""
673
# bzr 0.0.6 imposes the constraint that the inventory_id
674
# must be the same as its revision, so this is trivial.
675
if revision_id == None:
676
from bzrlib.inventory import Inventory
677
return Inventory(self.get_root_id())
679
return self.get_inventory(revision_id)
682
def revision_history(self):
683
"""Return sequence of revision hashes on to this branch.
685
>>> ScratchBranch().revision_history()
690
return [l.rstrip('\r\n') for l in
691
self.controlfile('revision-history', 'r').readlines()]
696
def common_ancestor(self, other, self_revno=None, other_revno=None):
699
>>> sb = ScratchBranch(files=['foo', 'foo~'])
700
>>> sb.common_ancestor(sb) == (None, None)
702
>>> commit.commit(sb, "Committing first revision", verbose=False)
703
>>> sb.common_ancestor(sb)[0]
705
>>> clone = sb.clone()
706
>>> commit.commit(sb, "Committing second revision", verbose=False)
707
>>> sb.common_ancestor(sb)[0]
709
>>> sb.common_ancestor(clone)[0]
711
>>> commit.commit(clone, "Committing divergent second revision",
713
>>> sb.common_ancestor(clone)[0]
715
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
717
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
719
>>> clone2 = sb.clone()
720
>>> sb.common_ancestor(clone2)[0]
722
>>> sb.common_ancestor(clone2, self_revno=1)[0]
724
>>> sb.common_ancestor(clone2, other_revno=1)[0]
727
my_history = self.revision_history()
728
other_history = other.revision_history()
729
if self_revno is None:
730
self_revno = len(my_history)
731
if other_revno is None:
732
other_revno = len(other_history)
733
indices = range(min((self_revno, other_revno)))
736
if my_history[r] == other_history[r]:
737
return r+1, my_history[r]
742
"""Return current revision number for this branch.
744
That is equivalent to the number of revisions committed to
747
return len(self.revision_history())
750
def last_patch(self):
751
"""Return last patch hash, or None if no history.
753
ph = self.revision_history()
760
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
762
If self and other have not diverged, return a list of the revisions
763
present in other, but missing from self.
765
>>> from bzrlib.commit import commit
766
>>> bzrlib.trace.silent = True
767
>>> br1 = ScratchBranch()
768
>>> br2 = ScratchBranch()
769
>>> br1.missing_revisions(br2)
771
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
772
>>> br1.missing_revisions(br2)
774
>>> br2.missing_revisions(br1)
776
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
777
>>> br1.missing_revisions(br2)
779
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
780
>>> br1.missing_revisions(br2)
782
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
783
>>> br1.missing_revisions(br2)
784
Traceback (most recent call last):
785
DivergedBranches: These branches have diverged.
787
self_history = self.revision_history()
788
self_len = len(self_history)
789
other_history = other.revision_history()
790
other_len = len(other_history)
791
common_index = min(self_len, other_len) -1
792
if common_index >= 0 and \
793
self_history[common_index] != other_history[common_index]:
794
raise DivergedBranches(self, other)
796
if stop_revision is None:
797
stop_revision = other_len
798
elif stop_revision > other_len:
799
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
801
return other_history[self_len:stop_revision]
804
def update_revisions(self, other, stop_revision=None):
805
"""Pull in all new revisions from other branch.
807
from bzrlib.fetch import greedy_fetch
808
from bzrlib.revision import get_intervening_revisions
810
pb = bzrlib.ui.ui_factory.progress_bar()
811
pb.update('comparing histories')
812
if stop_revision is None:
813
other_revision = other.last_patch()
815
other_revision = other.lookup_revision(stop_revision)
816
count = greedy_fetch(self, other, other_revision, pb)[0]
818
revision_ids = self.missing_revisions(other, stop_revision)
819
except DivergedBranches, e:
821
revision_ids = get_intervening_revisions(self.last_patch(),
822
other_revision, self)
823
assert self.last_patch() not in revision_ids
824
except bzrlib.errors.NotAncestor:
827
self.append_revision(*revision_ids)
830
def install_revisions(self, other, revision_ids, pb):
831
if hasattr(other.revision_store, "prefetch"):
832
other.revision_store.prefetch(revision_ids)
833
if hasattr(other.inventory_store, "prefetch"):
835
for rev_id in revision_ids:
837
revision = other.get_revision(rev_id).inventory_id
838
inventory_ids.append(revision)
839
except bzrlib.errors.NoSuchRevision:
841
other.inventory_store.prefetch(inventory_ids)
844
pb = bzrlib.ui.ui_factory.progress_bar()
851
for i, rev_id in enumerate(revision_ids):
852
pb.update('fetching revision', i+1, len(revision_ids))
854
rev = other.get_revision(rev_id)
855
except bzrlib.errors.NoSuchRevision:
859
revisions.append(rev)
860
inv = other.get_inventory(str(rev.inventory_id))
861
for key, entry in inv.iter_entries():
862
if entry.text_id is None:
864
if entry.text_id not in self.text_store:
865
needed_texts.add(entry.text_id)
869
count, cp_fail = self.text_store.copy_multi(other.text_store,
871
#print "Added %d texts." % count
872
inventory_ids = [ f.inventory_id for f in revisions ]
873
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
875
#print "Added %d inventories." % count
876
revision_ids = [ f.revision_id for f in revisions]
878
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
881
assert len(cp_fail) == 0
882
return count, failures
885
def commit(self, *args, **kw):
886
from bzrlib.commit import commit
887
commit(self, *args, **kw)
890
def lookup_revision(self, revision):
891
"""Return the revision identifier for a given revision information."""
892
revno, info = self._get_revision_info(revision)
896
def revision_id_to_revno(self, revision_id):
897
"""Given a revision id, return its revno"""
898
history = self.revision_history()
900
return history.index(revision_id) + 1
902
raise bzrlib.errors.NoSuchRevision(self, revision_id)
905
def get_revision_info(self, revision):
906
"""Return (revno, revision id) for revision identifier.
908
revision can be an integer, in which case it is assumed to be revno (though
909
this will translate negative values into positive ones)
910
revision can also be a string, in which case it is parsed for something like
911
'date:' or 'revid:' etc.
913
revno, rev_id = self._get_revision_info(revision)
915
raise bzrlib.errors.NoSuchRevision(self, revision)
918
def get_rev_id(self, revno, history=None):
919
"""Find the revision id of the specified revno."""
923
history = self.revision_history()
924
elif revno <= 0 or revno > len(history):
925
raise bzrlib.errors.NoSuchRevision(self, revno)
926
return history[revno - 1]
928
def _get_revision_info(self, revision):
929
"""Return (revno, revision id) for revision specifier.
931
revision can be an integer, in which case it is assumed to be revno
932
(though this will translate negative values into positive ones)
933
revision can also be a string, in which case it is parsed for something
934
like 'date:' or 'revid:' etc.
936
A revid is always returned. If it is None, the specifier referred to
937
the null revision. If the revid does not occur in the revision
938
history, revno will be None.
944
try:# Convert to int if possible
945
revision = int(revision)
948
revs = self.revision_history()
949
if isinstance(revision, int):
951
revno = len(revs) + revision + 1
954
rev_id = self.get_rev_id(revno, revs)
955
elif isinstance(revision, basestring):
956
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
957
if revision.startswith(prefix):
958
result = func(self, revs, revision)
960
revno, rev_id = result
963
rev_id = self.get_rev_id(revno, revs)
966
raise BzrError('No namespace registered for string: %r' %
969
raise TypeError('Unhandled revision type %s' % revision)
973
raise bzrlib.errors.NoSuchRevision(self, revision)
976
def _namespace_revno(self, revs, revision):
977
"""Lookup a revision by revision number"""
978
assert revision.startswith('revno:')
980
return (int(revision[6:]),)
983
REVISION_NAMESPACES['revno:'] = _namespace_revno
985
def _namespace_revid(self, revs, revision):
986
assert revision.startswith('revid:')
987
rev_id = revision[len('revid:'):]
989
return revs.index(rev_id) + 1, rev_id
992
REVISION_NAMESPACES['revid:'] = _namespace_revid
994
def _namespace_last(self, revs, revision):
995
assert revision.startswith('last:')
997
offset = int(revision[5:])
1002
raise BzrError('You must supply a positive value for --revision last:XXX')
1003
return (len(revs) - offset + 1,)
1004
REVISION_NAMESPACES['last:'] = _namespace_last
1006
def _namespace_tag(self, revs, revision):
1007
assert revision.startswith('tag:')
1008
raise BzrError('tag: namespace registered, but not implemented.')
1009
REVISION_NAMESPACES['tag:'] = _namespace_tag
1011
def _namespace_date(self, revs, revision):
1012
assert revision.startswith('date:')
1014
# Spec for date revisions:
1016
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1017
# it can also start with a '+/-/='. '+' says match the first
1018
# entry after the given date. '-' is match the first entry before the date
1019
# '=' is match the first entry after, but still on the given date.
1021
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1022
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1023
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1024
# May 13th, 2005 at 0:00
1026
# So the proper way of saying 'give me all entries for today' is:
1027
# -r {date:+today}:{date:-tomorrow}
1028
# The default is '=' when not supplied
1031
if val[:1] in ('+', '-', '='):
1032
match_style = val[:1]
1035
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1036
if val.lower() == 'yesterday':
1037
dt = today - datetime.timedelta(days=1)
1038
elif val.lower() == 'today':
1040
elif val.lower() == 'tomorrow':
1041
dt = today + datetime.timedelta(days=1)
1044
# This should be done outside the function to avoid recompiling it.
1045
_date_re = re.compile(
1046
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1048
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1050
m = _date_re.match(val)
1051
if not m or (not m.group('date') and not m.group('time')):
1052
raise BzrError('Invalid revision date %r' % revision)
1055
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1057
year, month, day = today.year, today.month, today.day
1059
hour = int(m.group('hour'))
1060
minute = int(m.group('minute'))
1061
if m.group('second'):
1062
second = int(m.group('second'))
1066
hour, minute, second = 0,0,0
1068
dt = datetime.datetime(year=year, month=month, day=day,
1069
hour=hour, minute=minute, second=second)
1073
if match_style == '-':
1075
elif match_style == '=':
1076
last = dt + datetime.timedelta(days=1)
1079
for i in range(len(revs)-1, -1, -1):
1080
r = self.get_revision(revs[i])
1081
# TODO: Handle timezone.
1082
dt = datetime.datetime.fromtimestamp(r.timestamp)
1083
if first >= dt and (last is None or dt >= last):
1086
for i in range(len(revs)):
1087
r = self.get_revision(revs[i])
1088
# TODO: Handle timezone.
1089
dt = datetime.datetime.fromtimestamp(r.timestamp)
1090
if first <= dt and (last is None or dt <= last):
1092
REVISION_NAMESPACES['date:'] = _namespace_date
1094
def revision_tree(self, revision_id):
1095
"""Return Tree for a revision on this branch.
1097
`revision_id` may be None for the null revision, in which case
1098
an `EmptyTree` is returned."""
1099
# TODO: refactor this to use an existing revision object
1100
# so we don't need to read it in twice.
1101
if revision_id == None:
1104
inv = self.get_revision_inventory(revision_id)
1105
return RevisionTree(self.text_store, inv)
1108
def working_tree(self):
1109
"""Return a `Tree` for the working copy."""
1110
from workingtree import WorkingTree
1111
return WorkingTree(self.base, self.read_working_inventory())
1114
def basis_tree(self):
1115
"""Return `Tree` object for last revision.
1117
If there are no revisions yet, return an `EmptyTree`.
1119
r = self.last_patch()
1123
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1127
def rename_one(self, from_rel, to_rel):
1130
This can change the directory or the filename or both.
1134
tree = self.working_tree()
1135
inv = tree.inventory
1136
if not tree.has_filename(from_rel):
1137
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1138
if tree.has_filename(to_rel):
1139
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1141
file_id = inv.path2id(from_rel)
1143
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1145
if inv.path2id(to_rel):
1146
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1148
to_dir, to_tail = os.path.split(to_rel)
1149
to_dir_id = inv.path2id(to_dir)
1150
if to_dir_id == None and to_dir != '':
1151
raise BzrError("can't determine destination directory id for %r" % to_dir)
1153
mutter("rename_one:")
1154
mutter(" file_id {%s}" % file_id)
1155
mutter(" from_rel %r" % from_rel)
1156
mutter(" to_rel %r" % to_rel)
1157
mutter(" to_dir %r" % to_dir)
1158
mutter(" to_dir_id {%s}" % to_dir_id)
1160
inv.rename(file_id, to_dir_id, to_tail)
1162
from_abs = self.abspath(from_rel)
1163
to_abs = self.abspath(to_rel)
1165
os.rename(from_abs, to_abs)
1167
raise BzrError("failed to rename %r to %r: %s"
1168
% (from_abs, to_abs, e[1]),
1169
["rename rolled back"])
1171
self._write_inventory(inv)
1176
def move(self, from_paths, to_name):
1179
to_name must exist as a versioned directory.
1181
If to_name exists and is a directory, the files are moved into
1182
it, keeping their old names. If it is a directory,
1184
Note that to_name is only the last component of the new name;
1185
this doesn't change the directory.
1187
This returns a list of (from_path, to_path) pairs for each
1188
entry that is moved.
1193
## TODO: Option to move IDs only
1194
assert not isinstance(from_paths, basestring)
1195
tree = self.working_tree()
1196
inv = tree.inventory
1197
to_abs = self.abspath(to_name)
1198
if not isdir(to_abs):
1199
raise BzrError("destination %r is not a directory" % to_abs)
1200
if not tree.has_filename(to_name):
1201
raise BzrError("destination %r not in working directory" % to_abs)
1202
to_dir_id = inv.path2id(to_name)
1203
if to_dir_id == None and to_name != '':
1204
raise BzrError("destination %r is not a versioned directory" % to_name)
1205
to_dir_ie = inv[to_dir_id]
1206
if to_dir_ie.kind not in ('directory', 'root_directory'):
1207
raise BzrError("destination %r is not a directory" % to_abs)
1209
to_idpath = inv.get_idpath(to_dir_id)
1211
for f in from_paths:
1212
if not tree.has_filename(f):
1213
raise BzrError("%r does not exist in working tree" % f)
1214
f_id = inv.path2id(f)
1216
raise BzrError("%r is not versioned" % f)
1217
name_tail = splitpath(f)[-1]
1218
dest_path = appendpath(to_name, name_tail)
1219
if tree.has_filename(dest_path):
1220
raise BzrError("destination %r already exists" % dest_path)
1221
if f_id in to_idpath:
1222
raise BzrError("can't move %r to a subdirectory of itself" % f)
1224
# OK, so there's a race here, it's possible that someone will
1225
# create a file in this interval and then the rename might be
1226
# left half-done. But we should have caught most problems.
1228
for f in from_paths:
1229
name_tail = splitpath(f)[-1]
1230
dest_path = appendpath(to_name, name_tail)
1231
result.append((f, dest_path))
1232
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1234
os.rename(self.abspath(f), self.abspath(dest_path))
1236
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1237
["rename rolled back"])
1239
self._write_inventory(inv)
1246
def revert(self, filenames, old_tree=None, backups=True):
1247
"""Restore selected files to the versions from a previous tree.
1250
If true (default) backups are made of files before
1253
from bzrlib.errors import NotVersionedError, BzrError
1254
from bzrlib.atomicfile import AtomicFile
1255
from bzrlib.osutils import backup_file
1257
inv = self.read_working_inventory()
1258
if old_tree is None:
1259
old_tree = self.basis_tree()
1260
old_inv = old_tree.inventory
1263
for fn in filenames:
1264
file_id = inv.path2id(fn)
1266
raise NotVersionedError("not a versioned file", fn)
1267
if not old_inv.has_id(file_id):
1268
raise BzrError("file not present in old tree", fn, file_id)
1269
nids.append((fn, file_id))
1271
# TODO: Rename back if it was previously at a different location
1273
# TODO: If given a directory, restore the entire contents from
1274
# the previous version.
1276
# TODO: Make a backup to a temporary file.
1278
# TODO: If the file previously didn't exist, delete it?
1279
for fn, file_id in nids:
1282
f = AtomicFile(fn, 'wb')
1284
f.write(old_tree.get_file(file_id).read())
1290
def pending_merges(self):
1291
"""Return a list of pending merges.
1293
These are revisions that have been merged into the working
1294
directory but not yet committed.
1296
cfn = self.controlfilename('pending-merges')
1297
if not os.path.exists(cfn):
1300
for l in self.controlfile('pending-merges', 'r').readlines():
1301
p.append(l.rstrip('\n'))
1305
def add_pending_merge(self, revision_id):
1306
from bzrlib.revision import validate_revision_id
1308
validate_revision_id(revision_id)
1310
p = self.pending_merges()
1311
if revision_id in p:
1313
p.append(revision_id)
1314
self.set_pending_merges(p)
1317
def set_pending_merges(self, rev_list):
1318
from bzrlib.atomicfile import AtomicFile
1321
f = AtomicFile(self.controlfilename('pending-merges'))
1332
def get_parent(self):
1333
"""Return the parent location of the branch.
1335
This is the default location for push/pull/missing. The usual
1336
pattern is that the user can override it by specifying a
1340
_locs = ['parent', 'pull', 'x-pull']
1343
return self.controlfile(l, 'r').read().strip('\n')
1345
if e.errno != errno.ENOENT:
1350
def set_parent(self, url):
1351
# TODO: Maybe delete old location files?
1352
from bzrlib.atomicfile import AtomicFile
1355
f = AtomicFile(self.controlfilename('parent'))
1364
def check_revno(self, revno):
1366
Check whether a revno corresponds to any revision.
1367
Zero (the NULL revision) is considered valid.
1370
self.check_real_revno(revno)
1372
def check_real_revno(self, revno):
1374
Check whether a revno corresponds to a real revision.
1375
Zero (the NULL revision) is considered invalid
1377
if revno < 1 or revno > self.revno():
1378
raise InvalidRevisionNumber(revno)
1383
class ScratchBranch(Branch):
1384
"""Special test class: a branch that cleans up after itself.
1386
>>> b = ScratchBranch()
1394
def __init__(self, files=[], dirs=[], base=None):
1395
"""Make a test branch.
1397
This creates a temporary directory and runs init-tree in it.
1399
If any files are listed, they are created in the working copy.
1401
from tempfile import mkdtemp
1406
Branch.__init__(self, base, init=init)
1408
os.mkdir(self.abspath(d))
1411
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1416
>>> orig = ScratchBranch(files=["file1", "file2"])
1417
>>> clone = orig.clone()
1418
>>> os.path.samefile(orig.base, clone.base)
1420
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1423
from shutil import copytree
1424
from tempfile import mkdtemp
1427
copytree(self.base, base, symlinks=True)
1428
return ScratchBranch(base=base)
1436
"""Destroy the test branch, removing the scratch directory."""
1437
from shutil import rmtree
1440
mutter("delete ScratchBranch %s" % self.base)
1443
# Work around for shutil.rmtree failing on Windows when
1444
# readonly files are encountered
1445
mutter("hit exception in destroying ScratchBranch: %s" % e)
1446
for root, dirs, files in os.walk(self.base, topdown=False):
1448
os.chmod(os.path.join(root, name), 0700)
1454
######################################################################
1458
def is_control_file(filename):
1459
## FIXME: better check
1460
filename = os.path.normpath(filename)
1461
while filename != '':
1462
head, tail = os.path.split(filename)
1463
## mutter('check %r for control file' % ((head, tail), ))
1464
if tail == bzrlib.BZRDIR:
1466
if filename == head:
1473
def gen_file_id(name):
1474
"""Return new file id.
1476
This should probably generate proper UUIDs, but for the moment we
1477
cope with just randomness because running uuidgen every time is
1480
from binascii import hexlify
1481
from time import time
1483
# get last component
1484
idx = name.rfind('/')
1486
name = name[idx+1 : ]
1487
idx = name.rfind('\\')
1489
name = name[idx+1 : ]
1491
# make it not a hidden file
1492
name = name.lstrip('.')
1494
# remove any wierd characters; we don't escape them but rather
1495
# just pull them out
1496
name = re.sub(r'[^\w.]', '', name)
1498
s = hexlify(rand_bytes(8))
1499
return '-'.join((name, compact_date(time()), s))
1503
"""Return a new tree-root file id."""
1504
return gen_file_id('TREE_ROOT')
1507
def pull_loc(branch):
1508
# TODO: Should perhaps just make attribute be 'base' in
1509
# RemoteBranch and Branch?
1510
if hasattr(branch, "baseurl"):
1511
return branch.baseurl
1516
def copy_branch(branch_from, to_location, revision=None):
1517
"""Copy branch_from into the existing directory to_location.
1520
If not None, only revisions up to this point will be copied.
1521
The head of the new branch will be that revision.
1524
The name of a local directory that exists but is empty.
1526
from bzrlib.merge import merge
1527
from bzrlib.branch import Branch
1529
assert isinstance(branch_from, Branch)
1530
assert isinstance(to_location, basestring)
1532
br_to = Branch(to_location, init=True)
1533
br_to.set_root_id(branch_from.get_root_id())
1534
if revision is None:
1535
revno = branch_from.revno()
1537
revno, rev_id = branch_from.get_revision_info(revision)
1538
br_to.update_revisions(branch_from, stop_revision=revno)
1539
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1540
check_clean=False, ignore_zero=True)
1542
from_location = pull_loc(branch_from)
1543
br_to.set_parent(pull_loc(branch_from))
added
removed
bzrlib/branch.py
