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
21
from warnings import warn
22
from cStringIO import StringIO
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision
39
from bzrlib.delta import compare_trees
40
from bzrlib.tree import EmptyTree, RevisionTree
41
from bzrlib.inventory import Inventory
42
from bzrlib.store import copy_all
43
from bzrlib.store.compressed_text import CompressedTextStore
44
from bzrlib.store.text import TextStore
45
from bzrlib.store.weave import WeaveStore
46
import bzrlib.transactions as transactions
47
from bzrlib.transport import Transport, get_transport
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
54
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
55
## TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations.
63
def find_branch(*ignored, **ignored_too):
64
# XXX: leave this here for about one release, then remove it
65
raise NotImplementedError('find_branch() is not supported anymore, '
66
'please use one of the new branch constructors')
68
######################################################################
72
"""Branch holding a history of revisions.
75
Base directory/url of the branch.
79
def __init__(self, *ignored, **ignored_too):
80
raise NotImplementedError('The Branch class is abstract')
83
def open_downlevel(base):
84
"""Open a branch which may be of an old format.
86
Only local branches are supported."""
87
return _Branch(get_transport(base), relax_version_check=True)
91
"""Open an existing branch, rooted at 'base' (url)"""
92
t = get_transport(base)
93
mutter("trying to open %r with transport %r", base, t)
97
def open_containing(url):
98
"""Open an existing branch which contains url.
100
This probes for a branch at url, and searches upwards from there.
102
Basically we keep looking up until we find the control directory or
103
run into the root. If there isn't one, raises NotBranchError.
105
t = get_transport(url)
109
except NotBranchError:
111
new_t = t.clone('..')
112
if new_t.base == t.base:
113
# reached the root, whatever that may be
114
raise NotBranchError('%s is not in a branch' % url)
118
def initialize(base):
119
"""Create a new branch, rooted at 'base' (url)"""
120
t = get_transport(base)
121
return _Branch(t, init=True)
123
def setup_caching(self, cache_root):
124
"""Subclasses that care about caching should override this, and set
125
up cached stores located under cache_root.
127
self.cache_root = cache_root
130
class _Branch(Branch):
131
"""A branch stored in the actual filesystem.
133
Note that it's "local" in the context of the filesystem; it doesn't
134
really matter if it's on an nfs/smb/afs/coda/... share, as long as
135
it's writable, and can be accessed via the normal filesystem API.
141
If _lock_mode is true, a positive count of the number of times the
145
Lock object from bzrlib.lock.
147
# We actually expect this class to be somewhat short-lived; part of its
148
# purpose is to try to isolate what bits of the branch logic are tied to
149
# filesystem access, so that in a later step, we can extricate them to
150
# a separarte ("storage") class.
154
_inventory_weave = None
156
# Map some sort of prefix into a namespace
157
# stuff like "revno:10", "revid:", etc.
158
# This should match a prefix with a function which accepts
159
REVISION_NAMESPACES = {}
161
def push_stores(self, branch_to):
162
"""Copy the content of this branches store to branch_to."""
163
if (self._branch_format != branch_to._branch_format
164
or self._branch_format != 4):
165
from bzrlib.fetch import greedy_fetch
166
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
167
self, self._branch_format, branch_to, branch_to._branch_format)
168
greedy_fetch(to_branch=branch_to, from_branch=self,
169
revision=self.last_revision())
172
store_pairs = ((self.text_store, branch_to.text_store),
173
(self.inventory_store, branch_to.inventory_store),
174
(self.revision_store, branch_to.revision_store))
176
for from_store, to_store in store_pairs:
177
copy_all(from_store, to_store)
178
except UnlistableStore:
179
raise UnlistableBranch(from_store)
181
def __init__(self, transport, init=False,
182
relax_version_check=False):
183
"""Create new branch object at a particular location.
185
transport -- A Transport object, defining how to access files.
186
(If a string, transport.transport() will be used to
187
create a Transport object)
189
init -- If True, create new control files in a previously
190
unversioned directory. If False, the branch must already
193
relax_version_check -- If true, the usual check for the branch
194
version is not applied. This is intended only for
195
upgrade/recovery type use; it's not guaranteed that
196
all operations will work on old format branches.
198
In the test suite, creation of new trees is tested using the
199
`ScratchBranch` class.
201
assert isinstance(transport, Transport), \
202
"%r is not a Transport" % transport
203
self._transport = transport
206
self._check_format(relax_version_check)
208
def get_store(name, compressed=True, prefixed=False):
209
# FIXME: This approach of assuming stores are all entirely compressed
210
# or entirely uncompressed is tidy, but breaks upgrade from
211
# some existing branches where there's a mixture; we probably
212
# still want the option to look for both.
213
relpath = self._rel_controlfilename(name)
215
store = CompressedTextStore(self._transport.clone(relpath),
218
store = TextStore(self._transport.clone(relpath),
220
#if self._transport.should_cache():
221
# cache_path = os.path.join(self.cache_root, name)
222
# os.mkdir(cache_path)
223
# store = bzrlib.store.CachedStore(store, cache_path)
225
def get_weave(name, prefixed=False):
226
relpath = self._rel_controlfilename(name)
227
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
228
if self._transport.should_cache():
229
ws.enable_cache = True
232
if self._branch_format == 4:
233
self.inventory_store = get_store('inventory-store')
234
self.text_store = get_store('text-store')
235
self.revision_store = get_store('revision-store')
236
elif self._branch_format == 5:
237
self.control_weaves = get_weave([])
238
self.weave_store = get_weave('weaves')
239
self.revision_store = get_store('revision-store', compressed=False)
240
elif self._branch_format == 6:
241
self.control_weaves = get_weave([])
242
self.weave_store = get_weave('weaves', prefixed=True)
243
self.revision_store = get_store('revision-store', compressed=False,
245
self._transaction = None
248
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
255
if self._lock_mode or self._lock:
256
# XXX: This should show something every time, and be suitable for
257
# headless operation and embedding
258
warn("branch %r was not explicitly unlocked" % self)
261
# TODO: It might be best to do this somewhere else,
262
# but it is nice for a Branch object to automatically
263
# cache it's information.
264
# Alternatively, we could have the Transport objects cache requests
265
# See the earlier discussion about how major objects (like Branch)
266
# should never expect their __del__ function to run.
267
if hasattr(self, 'cache_root') and self.cache_root is not None:
270
shutil.rmtree(self.cache_root)
273
self.cache_root = None
277
return self._transport.base
280
base = property(_get_base, doc="The URL for the root of this branch.")
282
def _finish_transaction(self):
283
"""Exit the current transaction."""
284
if self._transaction is None:
285
raise errors.LockError('Branch %s is not in a transaction' %
287
transaction = self._transaction
288
self._transaction = None
291
def get_transaction(self):
292
"""Return the current active transaction.
294
If no transaction is active, this returns a passthrough object
295
for which all data is immedaitely flushed and no caching happens.
297
if self._transaction is None:
298
return transactions.PassThroughTransaction()
300
return self._transaction
302
def _set_transaction(self, new_transaction):
303
"""Set a new active transaction."""
304
if self._transaction is not None:
305
raise errors.LockError('Branch %s is in a transaction already.' %
307
self._transaction = new_transaction
309
def lock_write(self):
310
mutter("lock write: %s (%s)", self, self._lock_count)
311
# TODO: Upgrade locking to support using a Transport,
312
# and potentially a remote locking protocol
314
if self._lock_mode != 'w':
315
raise LockError("can't upgrade to a write lock from %r" %
317
self._lock_count += 1
319
self._lock = self._transport.lock_write(
320
self._rel_controlfilename('branch-lock'))
321
self._lock_mode = 'w'
323
self._set_transaction(transactions.PassThroughTransaction())
326
mutter("lock read: %s (%s)", self, self._lock_count)
328
assert self._lock_mode in ('r', 'w'), \
329
"invalid lock mode %r" % self._lock_mode
330
self._lock_count += 1
332
self._lock = self._transport.lock_read(
333
self._rel_controlfilename('branch-lock'))
334
self._lock_mode = 'r'
336
self._set_transaction(transactions.ReadOnlyTransaction())
337
# 5K may be excessive, but hey, its a knob.
338
self.get_transaction().set_cache_size(5000)
341
mutter("unlock: %s (%s)", self, self._lock_count)
342
if not self._lock_mode:
343
raise LockError('branch %r is not locked' % (self))
345
if self._lock_count > 1:
346
self._lock_count -= 1
348
self._finish_transaction()
351
self._lock_mode = self._lock_count = None
353
def abspath(self, name):
354
"""Return absolute filename for something in the branch
356
XXX: Robert Collins 20051017 what is this used for? why is it a branch
357
method and not a tree method.
359
return self._transport.abspath(name)
361
def relpath(self, path):
362
"""Return path relative to this branch of something inside it.
364
Raises an error if path is not in this branch.
365
XXX: Robert Collins 20051017 what is this used for? why is it a branch
366
method and not a tree method.
368
return self._transport.relpath(path)
370
def _rel_controlfilename(self, file_or_path):
371
if isinstance(file_or_path, basestring):
372
file_or_path = [file_or_path]
373
return [bzrlib.BZRDIR] + file_or_path
375
def controlfilename(self, file_or_path):
376
"""Return location relative to branch."""
377
return self._transport.abspath(self._rel_controlfilename(file_or_path))
380
def controlfile(self, file_or_path, mode='r'):
381
"""Open a control file for this branch.
383
There are two classes of file in the control directory: text
384
and binary. binary files are untranslated byte streams. Text
385
control files are stored with Unix newlines and in UTF-8, even
386
if the platform or locale defaults are different.
388
Controlfiles should almost never be opened in write mode but
389
rather should be atomically copied and replaced using atomicfile.
393
relpath = self._rel_controlfilename(file_or_path)
394
#TODO: codecs.open() buffers linewise, so it was overloaded with
395
# a much larger buffer, do we need to do the same for getreader/getwriter?
397
return self._transport.get(relpath)
399
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
401
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
403
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
405
raise BzrError("invalid controlfile mode %r" % mode)
407
def put_controlfile(self, path, f, encode=True):
408
"""Write an entry as a controlfile.
410
:param path: The path to put the file, relative to the .bzr control
412
:param f: A file-like or string object whose contents should be copied.
413
:param encode: If true, encode the contents as utf-8
415
self.put_controlfiles([(path, f)], encode=encode)
417
def put_controlfiles(self, files, encode=True):
418
"""Write several entries as controlfiles.
420
:param files: A list of [(path, file)] pairs, where the path is the directory
421
underneath the bzr control directory
422
:param encode: If true, encode the contents as utf-8
426
for path, f in files:
428
if isinstance(f, basestring):
429
f = f.encode('utf-8', 'replace')
431
f = codecs.getwriter('utf-8')(f, errors='replace')
432
path = self._rel_controlfilename(path)
433
ctrl_files.append((path, f))
434
self._transport.put_multi(ctrl_files)
436
def _make_control(self):
437
from bzrlib.inventory import Inventory
438
from bzrlib.weavefile import write_weave_v5
439
from bzrlib.weave import Weave
441
# Create an empty inventory
443
# if we want per-tree root ids then this is the place to set
444
# them; they're not needed for now and so ommitted for
446
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
447
empty_inv = sio.getvalue()
449
bzrlib.weavefile.write_weave_v5(Weave(), sio)
450
empty_weave = sio.getvalue()
452
dirs = [[], 'revision-store', 'weaves']
454
"This is a Bazaar-NG control directory.\n"
455
"Do not change any files in this directory.\n"),
456
('branch-format', BZR_BRANCH_FORMAT_6),
457
('revision-history', ''),
460
('pending-merges', ''),
461
('inventory', empty_inv),
462
('inventory.weave', empty_weave),
463
('ancestry.weave', empty_weave)
465
cfn = self._rel_controlfilename
466
self._transport.mkdir_multi([cfn(d) for d in dirs])
467
self.put_controlfiles(files)
468
mutter('created control directory in ' + self._transport.base)
470
def _check_format(self, relax_version_check):
471
"""Check this branch format is supported.
473
The format level is stored, as an integer, in
474
self._branch_format for code that needs to check it later.
476
In the future, we might need different in-memory Branch
477
classes to support downlevel branches. But not yet.
480
fmt = self.controlfile('branch-format', 'r').read()
482
raise NotBranchError(self.base)
483
mutter("got branch format %r", fmt)
484
if fmt == BZR_BRANCH_FORMAT_6:
485
self._branch_format = 6
486
elif fmt == BZR_BRANCH_FORMAT_5:
487
self._branch_format = 5
488
elif fmt == BZR_BRANCH_FORMAT_4:
489
self._branch_format = 4
491
if (not relax_version_check
492
and self._branch_format not in (5, 6)):
493
raise errors.UnsupportedFormatError(
494
'sorry, branch format %r not supported' % fmt,
495
['use a different bzr version',
496
'or remove the .bzr directory'
497
' and "bzr init" again'])
499
def get_root_id(self):
500
"""Return the id of this branches root"""
501
inv = self.read_working_inventory()
502
return inv.root.file_id
504
def set_root_id(self, file_id):
505
inv = self.read_working_inventory()
506
orig_root_id = inv.root.file_id
507
del inv._byid[inv.root.file_id]
508
inv.root.file_id = file_id
509
inv._byid[inv.root.file_id] = inv.root
512
if entry.parent_id in (None, orig_root_id):
513
entry.parent_id = inv.root.file_id
514
self._write_inventory(inv)
516
def read_working_inventory(self):
517
"""Read the working inventory."""
520
# ElementTree does its own conversion from UTF-8, so open in
522
f = self.controlfile('inventory', 'rb')
523
return bzrlib.xml5.serializer_v5.read_inventory(f)
528
def _write_inventory(self, inv):
529
"""Update the working inventory.
531
That is to say, the inventory describing changes underway, that
532
will be committed to the next revision.
534
from cStringIO import StringIO
538
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
540
# Transport handles atomicity
541
self.put_controlfile('inventory', sio)
545
mutter('wrote working inventory')
547
inventory = property(read_working_inventory, _write_inventory, None,
548
"""Inventory for the working copy.""")
550
def add(self, files, ids=None):
551
"""Make files versioned.
553
Note that the command line normally calls smart_add instead,
554
which can automatically recurse.
556
This puts the files in the Added state, so that they will be
557
recorded by the next commit.
560
List of paths to add, relative to the base of the tree.
563
If set, use these instead of automatically generated ids.
564
Must be the same length as the list of files, but may
565
contain None for ids that are to be autogenerated.
567
TODO: Perhaps have an option to add the ids even if the files do
570
TODO: Perhaps yield the ids and paths as they're added.
572
# TODO: Re-adding a file that is removed in the working copy
573
# should probably put it back with the previous ID.
574
if isinstance(files, basestring):
575
assert(ids is None or isinstance(ids, basestring))
581
ids = [None] * len(files)
583
assert(len(ids) == len(files))
587
inv = self.read_working_inventory()
588
for f,file_id in zip(files, ids):
589
if is_control_file(f):
590
raise BzrError("cannot add control file %s" % quotefn(f))
595
raise BzrError("cannot add top-level %r" % f)
597
fullpath = os.path.normpath(self.abspath(f))
600
kind = file_kind(fullpath)
602
# maybe something better?
603
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
605
if not InventoryEntry.versionable_kind(kind):
606
raise BzrError('cannot add: not a versionable file ('
607
'i.e. regular file, symlink or directory): %s' % quotefn(f))
610
file_id = gen_file_id(f)
611
inv.add_path(f, kind=kind, file_id=file_id)
613
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
615
self._write_inventory(inv)
620
def print_file(self, file, revno):
621
"""Print `file` to stdout."""
624
tree = self.revision_tree(self.get_rev_id(revno))
625
# use inventory as it was in that revision
626
file_id = tree.inventory.path2id(file)
628
raise BzrError("%r is not present in revision %s" % (file, revno))
629
tree.print_file(file_id)
634
def remove(self, files, verbose=False):
635
"""Mark nominated files for removal from the inventory.
637
This does not remove their text. This does not run on
639
TODO: Refuse to remove modified files unless --force is given?
641
TODO: Do something useful with directories.
643
TODO: Should this remove the text or not? Tough call; not
644
removing may be useful and the user can just use use rm, and
645
is the opposite of add. Removing it is consistent with most
646
other tools. Maybe an option.
648
## TODO: Normalize names
649
## TODO: Remove nested loops; better scalability
650
if isinstance(files, basestring):
656
tree = self.working_tree()
659
# do this before any modifications
663
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
664
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
666
# having remove it, it must be either ignored or unknown
667
if tree.is_ignored(f):
671
show_status(new_status, inv[fid].kind, quotefn(f))
674
self._write_inventory(inv)
678
# FIXME: this doesn't need to be a branch method
679
def set_inventory(self, new_inventory_list):
680
from bzrlib.inventory import Inventory, InventoryEntry
681
inv = Inventory(self.get_root_id())
682
for path, file_id, parent, kind in new_inventory_list:
683
name = os.path.basename(path)
686
# fixme, there should be a factory function inv,add_??
687
if kind == 'directory':
688
inv.add(inventory.InventoryDirectory(file_id, name, parent))
690
inv.add(inventory.InventoryFile(file_id, name, parent))
691
elif kind == 'symlink':
692
inv.add(inventory.InventoryLink(file_id, name, parent))
694
raise BzrError("unknown kind %r" % kind)
695
self._write_inventory(inv)
698
"""Return all unknown files.
700
These are files in the working directory that are not versioned or
701
control files or ignored.
703
>>> b = ScratchBranch(files=['foo', 'foo~'])
704
>>> list(b.unknowns())
707
>>> list(b.unknowns())
710
>>> list(b.unknowns())
713
return self.working_tree().unknowns()
716
def append_revision(self, *revision_ids):
717
for revision_id in revision_ids:
718
mutter("add {%s} to revision-history" % revision_id)
721
rev_history = self.revision_history()
722
rev_history.extend(revision_ids)
723
self.put_controlfile('revision-history', '\n'.join(rev_history))
727
def has_revision(self, revision_id):
728
"""True if this branch has a copy of the revision.
730
This does not necessarily imply the revision is merge
731
or on the mainline."""
732
return (revision_id is None
733
or revision_id in self.revision_store)
735
def get_revision_xml_file(self, revision_id):
736
"""Return XML file object for revision object."""
737
if not revision_id or not isinstance(revision_id, basestring):
738
raise InvalidRevisionId(revision_id)
743
return self.revision_store[revision_id]
744
except (IndexError, KeyError):
745
raise bzrlib.errors.NoSuchRevision(self, revision_id)
750
get_revision_xml = get_revision_xml_file
752
def get_revision_xml(self, revision_id):
753
return self.get_revision_xml_file(revision_id).read()
756
def get_revision(self, revision_id):
757
"""Return the Revision object for a named revision"""
758
xml_file = self.get_revision_xml_file(revision_id)
761
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
762
except SyntaxError, e:
763
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
767
assert r.revision_id == revision_id
770
def get_revision_delta(self, revno):
771
"""Return the delta for one revision.
773
The delta is relative to its mainline predecessor, or the
774
empty tree for revision 1.
776
assert isinstance(revno, int)
777
rh = self.revision_history()
778
if not (1 <= revno <= len(rh)):
779
raise InvalidRevisionNumber(revno)
781
# revno is 1-based; list is 0-based
783
new_tree = self.revision_tree(rh[revno-1])
785
old_tree = EmptyTree()
787
old_tree = self.revision_tree(rh[revno-2])
789
return compare_trees(old_tree, new_tree)
791
def get_revision_sha1(self, revision_id):
792
"""Hash the stored value of a revision, and return it."""
793
# In the future, revision entries will be signed. At that
794
# point, it is probably best *not* to include the signature
795
# in the revision hash. Because that lets you re-sign
796
# the revision, (add signatures/remove signatures) and still
797
# have all hash pointers stay consistent.
798
# But for now, just hash the contents.
799
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
801
def get_ancestry(self, revision_id):
802
"""Return a list of revision-ids integrated by a revision.
804
This currently returns a list, but the ordering is not guaranteed:
807
if revision_id is None:
809
w = self.get_inventory_weave()
810
return [None] + map(w.idx_to_name,
811
w.inclusions([w.lookup(revision_id)]))
813
def get_inventory_weave(self):
814
return self.control_weaves.get_weave('inventory',
815
self.get_transaction())
817
def get_inventory(self, revision_id):
818
"""Get Inventory object by hash."""
819
xml = self.get_inventory_xml(revision_id)
820
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
822
def get_inventory_xml(self, revision_id):
823
"""Get inventory XML as a file object."""
825
assert isinstance(revision_id, basestring), type(revision_id)
826
iw = self.get_inventory_weave()
827
return iw.get_text(iw.lookup(revision_id))
829
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
831
def get_inventory_sha1(self, revision_id):
832
"""Return the sha1 hash of the inventory entry
834
return self.get_revision(revision_id).inventory_sha1
836
def get_revision_inventory(self, revision_id):
837
"""Return inventory of a past revision."""
838
# TODO: Unify this with get_inventory()
839
# bzr 0.0.6 and later imposes the constraint that the inventory_id
840
# must be the same as its revision, so this is trivial.
841
if revision_id == None:
842
return Inventory(self.get_root_id())
844
return self.get_inventory(revision_id)
846
def revision_history(self):
847
"""Return sequence of revision hashes on to this branch."""
850
transaction = self.get_transaction()
851
history = transaction.map.find_revision_history()
852
if history is not None:
853
mutter("cache hit for revision-history in %s", self)
855
history = [l.rstrip('\r\n') for l in
856
self.controlfile('revision-history', 'r').readlines()]
857
transaction.map.add_revision_history(history)
858
# this call is disabled because revision_history is
859
# not really an object yet, and the transaction is for objects.
860
# transaction.register_clean(history, precious=True)
865
def common_ancestor(self, other, self_revno=None, other_revno=None):
867
>>> from bzrlib.commit import commit
868
>>> sb = ScratchBranch(files=['foo', 'foo~'])
869
>>> sb.common_ancestor(sb) == (None, None)
871
>>> commit(sb, "Committing first revision", verbose=False)
872
>>> sb.common_ancestor(sb)[0]
874
>>> clone = sb.clone()
875
>>> commit(sb, "Committing second revision", verbose=False)
876
>>> sb.common_ancestor(sb)[0]
878
>>> sb.common_ancestor(clone)[0]
880
>>> commit(clone, "Committing divergent second revision",
882
>>> sb.common_ancestor(clone)[0]
884
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
886
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
888
>>> clone2 = sb.clone()
889
>>> sb.common_ancestor(clone2)[0]
891
>>> sb.common_ancestor(clone2, self_revno=1)[0]
893
>>> sb.common_ancestor(clone2, other_revno=1)[0]
896
my_history = self.revision_history()
897
other_history = other.revision_history()
898
if self_revno is None:
899
self_revno = len(my_history)
900
if other_revno is None:
901
other_revno = len(other_history)
902
indices = range(min((self_revno, other_revno)))
905
if my_history[r] == other_history[r]:
906
return r+1, my_history[r]
911
"""Return current revision number for this branch.
913
That is equivalent to the number of revisions committed to
916
return len(self.revision_history())
919
def last_revision(self):
920
"""Return last patch hash, or None if no history.
922
ph = self.revision_history()
929
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
930
"""Return a list of new revisions that would perfectly fit.
932
If self and other have not diverged, return a list of the revisions
933
present in other, but missing from self.
935
>>> from bzrlib.commit import commit
936
>>> bzrlib.trace.silent = True
937
>>> br1 = ScratchBranch()
938
>>> br2 = ScratchBranch()
939
>>> br1.missing_revisions(br2)
941
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
942
>>> br1.missing_revisions(br2)
944
>>> br2.missing_revisions(br1)
946
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
947
>>> br1.missing_revisions(br2)
949
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
950
>>> br1.missing_revisions(br2)
952
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
953
>>> br1.missing_revisions(br2)
954
Traceback (most recent call last):
955
DivergedBranches: These branches have diverged.
957
# FIXME: If the branches have diverged, but the latest
958
# revision in this branch is completely merged into the other,
959
# then we should still be able to pull.
960
self_history = self.revision_history()
961
self_len = len(self_history)
962
other_history = other.revision_history()
963
other_len = len(other_history)
964
common_index = min(self_len, other_len) -1
965
if common_index >= 0 and \
966
self_history[common_index] != other_history[common_index]:
967
raise DivergedBranches(self, other)
969
if stop_revision is None:
970
stop_revision = other_len
972
assert isinstance(stop_revision, int)
973
if stop_revision > other_len:
974
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
975
return other_history[self_len:stop_revision]
977
def update_revisions(self, other, stop_revision=None):
978
"""Pull in new perfect-fit revisions."""
979
from bzrlib.fetch import greedy_fetch
980
from bzrlib.revision import get_intervening_revisions
981
if stop_revision is None:
982
stop_revision = other.last_revision()
983
if (stop_revision is not None and
984
stop_revision in self.revision_history()):
986
greedy_fetch(to_branch=self, from_branch=other,
987
revision=stop_revision)
988
pullable_revs = self.missing_revisions(
989
other, other.revision_id_to_revno(stop_revision))
991
greedy_fetch(to_branch=self,
993
revision=pullable_revs[-1])
994
self.append_revision(*pullable_revs)
997
def commit(self, *args, **kw):
998
from bzrlib.commit import Commit
999
Commit().commit(self, *args, **kw)
1001
def revision_id_to_revno(self, revision_id):
1002
"""Given a revision id, return its revno"""
1003
if revision_id is None:
1005
history = self.revision_history()
1007
return history.index(revision_id) + 1
1009
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1011
def get_rev_id(self, revno, history=None):
1012
"""Find the revision id of the specified revno."""
1016
history = self.revision_history()
1017
elif revno <= 0 or revno > len(history):
1018
raise bzrlib.errors.NoSuchRevision(self, revno)
1019
return history[revno - 1]
1021
def revision_tree(self, revision_id):
1022
"""Return Tree for a revision on this branch.
1024
`revision_id` may be None for the null revision, in which case
1025
an `EmptyTree` is returned."""
1026
# TODO: refactor this to use an existing revision object
1027
# so we don't need to read it in twice.
1028
if revision_id == None:
1031
inv = self.get_revision_inventory(revision_id)
1032
return RevisionTree(self.weave_store, inv, revision_id)
1035
def working_tree(self):
1036
"""Return a `Tree` for the working copy."""
1037
from bzrlib.workingtree import WorkingTree
1038
# TODO: In the future, WorkingTree should utilize Transport
1039
# RobertCollins 20051003 - I don't think it should - working trees are
1040
# much more complex to keep consistent than our careful .bzr subset.
1041
# instead, we should say that working trees are local only, and optimise
1043
return WorkingTree(self.base, branch=self)
1046
def basis_tree(self):
1047
"""Return `Tree` object for last revision.
1049
If there are no revisions yet, return an `EmptyTree`.
1051
return self.revision_tree(self.last_revision())
1054
def rename_one(self, from_rel, to_rel):
1057
This can change the directory or the filename or both.
1061
tree = self.working_tree()
1062
inv = tree.inventory
1063
if not tree.has_filename(from_rel):
1064
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1065
if tree.has_filename(to_rel):
1066
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1068
file_id = inv.path2id(from_rel)
1070
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1072
if inv.path2id(to_rel):
1073
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1075
to_dir, to_tail = os.path.split(to_rel)
1076
to_dir_id = inv.path2id(to_dir)
1077
if to_dir_id == None and to_dir != '':
1078
raise BzrError("can't determine destination directory id for %r" % to_dir)
1080
mutter("rename_one:")
1081
mutter(" file_id {%s}" % file_id)
1082
mutter(" from_rel %r" % from_rel)
1083
mutter(" to_rel %r" % to_rel)
1084
mutter(" to_dir %r" % to_dir)
1085
mutter(" to_dir_id {%s}" % to_dir_id)
1087
inv.rename(file_id, to_dir_id, to_tail)
1089
from_abs = self.abspath(from_rel)
1090
to_abs = self.abspath(to_rel)
1092
rename(from_abs, to_abs)
1094
raise BzrError("failed to rename %r to %r: %s"
1095
% (from_abs, to_abs, e[1]),
1096
["rename rolled back"])
1098
self._write_inventory(inv)
1103
def move(self, from_paths, to_name):
1106
to_name must exist as a versioned directory.
1108
If to_name exists and is a directory, the files are moved into
1109
it, keeping their old names. If it is a directory,
1111
Note that to_name is only the last component of the new name;
1112
this doesn't change the directory.
1114
This returns a list of (from_path, to_path) pairs for each
1115
entry that is moved.
1120
## TODO: Option to move IDs only
1121
assert not isinstance(from_paths, basestring)
1122
tree = self.working_tree()
1123
inv = tree.inventory
1124
to_abs = self.abspath(to_name)
1125
if not isdir(to_abs):
1126
raise BzrError("destination %r is not a directory" % to_abs)
1127
if not tree.has_filename(to_name):
1128
raise BzrError("destination %r not in working directory" % to_abs)
1129
to_dir_id = inv.path2id(to_name)
1130
if to_dir_id == None and to_name != '':
1131
raise BzrError("destination %r is not a versioned directory" % to_name)
1132
to_dir_ie = inv[to_dir_id]
1133
if to_dir_ie.kind not in ('directory', 'root_directory'):
1134
raise BzrError("destination %r is not a directory" % to_abs)
1136
to_idpath = inv.get_idpath(to_dir_id)
1138
for f in from_paths:
1139
if not tree.has_filename(f):
1140
raise BzrError("%r does not exist in working tree" % f)
1141
f_id = inv.path2id(f)
1143
raise BzrError("%r is not versioned" % f)
1144
name_tail = splitpath(f)[-1]
1145
dest_path = appendpath(to_name, name_tail)
1146
if tree.has_filename(dest_path):
1147
raise BzrError("destination %r already exists" % dest_path)
1148
if f_id in to_idpath:
1149
raise BzrError("can't move %r to a subdirectory of itself" % f)
1151
# OK, so there's a race here, it's possible that someone will
1152
# create a file in this interval and then the rename might be
1153
# left half-done. But we should have caught most problems.
1155
for f in from_paths:
1156
name_tail = splitpath(f)[-1]
1157
dest_path = appendpath(to_name, name_tail)
1158
result.append((f, dest_path))
1159
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1161
rename(self.abspath(f), self.abspath(dest_path))
1163
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1164
["rename rolled back"])
1166
self._write_inventory(inv)
1173
def revert(self, filenames, old_tree=None, backups=True):
1174
"""Restore selected files to the versions from a previous tree.
1177
If true (default) backups are made of files before
1180
from bzrlib.errors import NotVersionedError, BzrError
1181
from bzrlib.atomicfile import AtomicFile
1182
from bzrlib.osutils import backup_file
1184
inv = self.read_working_inventory()
1185
if old_tree is None:
1186
old_tree = self.basis_tree()
1187
old_inv = old_tree.inventory
1190
for fn in filenames:
1191
file_id = inv.path2id(fn)
1193
raise NotVersionedError("not a versioned file", fn)
1194
if not old_inv.has_id(file_id):
1195
raise BzrError("file not present in old tree", fn, file_id)
1196
nids.append((fn, file_id))
1198
# TODO: Rename back if it was previously at a different location
1200
# TODO: If given a directory, restore the entire contents from
1201
# the previous version.
1203
# TODO: Make a backup to a temporary file.
1205
# TODO: If the file previously didn't exist, delete it?
1206
for fn, file_id in nids:
1209
f = AtomicFile(fn, 'wb')
1211
f.write(old_tree.get_file(file_id).read())
1217
def pending_merges(self):
1218
"""Return a list of pending merges.
1220
These are revisions that have been merged into the working
1221
directory but not yet committed.
1223
cfn = self._rel_controlfilename('pending-merges')
1224
if not self._transport.has(cfn):
1227
for l in self.controlfile('pending-merges', 'r').readlines():
1228
p.append(l.rstrip('\n'))
1232
def add_pending_merge(self, *revision_ids):
1233
# TODO: Perhaps should check at this point that the
1234
# history of the revision is actually present?
1235
p = self.pending_merges()
1237
for rev_id in revision_ids:
1243
self.set_pending_merges(p)
1245
def set_pending_merges(self, rev_list):
1248
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1253
def get_parent(self):
1254
"""Return the parent location of the branch.
1256
This is the default location for push/pull/missing. The usual
1257
pattern is that the user can override it by specifying a
1261
_locs = ['parent', 'pull', 'x-pull']
1264
return self.controlfile(l, 'r').read().strip('\n')
1266
if e.errno != errno.ENOENT:
1271
def set_parent(self, url):
1272
# TODO: Maybe delete old location files?
1273
from bzrlib.atomicfile import AtomicFile
1276
f = AtomicFile(self.controlfilename('parent'))
1285
def check_revno(self, revno):
1287
Check whether a revno corresponds to any revision.
1288
Zero (the NULL revision) is considered valid.
1291
self.check_real_revno(revno)
1293
def check_real_revno(self, revno):
1295
Check whether a revno corresponds to a real revision.
1296
Zero (the NULL revision) is considered invalid
1298
if revno < 1 or revno > self.revno():
1299
raise InvalidRevisionNumber(revno)
1305
class ScratchBranch(_Branch):
1306
"""Special test class: a branch that cleans up after itself.
1308
>>> b = ScratchBranch()
1316
def __init__(self, files=[], dirs=[], base=None):
1317
"""Make a test branch.
1319
This creates a temporary directory and runs init-tree in it.
1321
If any files are listed, they are created in the working copy.
1323
from tempfile import mkdtemp
1328
if isinstance(base, basestring):
1329
base = get_transport(base)
1330
_Branch.__init__(self, base, init=init)
1332
self._transport.mkdir(d)
1335
self._transport.put(f, 'content of %s' % f)
1340
>>> orig = ScratchBranch(files=["file1", "file2"])
1341
>>> clone = orig.clone()
1342
>>> if os.name != 'nt':
1343
... os.path.samefile(orig.base, clone.base)
1345
... orig.base == clone.base
1348
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1351
from shutil import copytree
1352
from tempfile import mkdtemp
1355
copytree(self.base, base, symlinks=True)
1356
return ScratchBranch(base=base)
1362
"""Destroy the test branch, removing the scratch directory."""
1363
from shutil import rmtree
1366
mutter("delete ScratchBranch %s" % self.base)
1369
# Work around for shutil.rmtree failing on Windows when
1370
# readonly files are encountered
1371
mutter("hit exception in destroying ScratchBranch: %s" % e)
1372
for root, dirs, files in os.walk(self.base, topdown=False):
1374
os.chmod(os.path.join(root, name), 0700)
1376
self._transport = None
1380
######################################################################
1384
def is_control_file(filename):
1385
## FIXME: better check
1386
filename = os.path.normpath(filename)
1387
while filename != '':
1388
head, tail = os.path.split(filename)
1389
## mutter('check %r for control file' % ((head, tail), ))
1390
if tail == bzrlib.BZRDIR:
1392
if filename == head:
1399
def gen_file_id(name):
1400
"""Return new file id.
1402
This should probably generate proper UUIDs, but for the moment we
1403
cope with just randomness because running uuidgen every time is
1406
from binascii import hexlify
1407
from time import time
1409
# get last component
1410
idx = name.rfind('/')
1412
name = name[idx+1 : ]
1413
idx = name.rfind('\\')
1415
name = name[idx+1 : ]
1417
# make it not a hidden file
1418
name = name.lstrip('.')
1420
# remove any wierd characters; we don't escape them but rather
1421
# just pull them out
1422
name = re.sub(r'[^\w.]', '', name)
1424
s = hexlify(rand_bytes(8))
1425
return '-'.join((name, compact_date(time()), s))
1429
"""Return a new tree-root file id."""
1430
return gen_file_id('TREE_ROOT')