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, is_ancestor, get_intervening_revisions
40
from bzrlib.delta import compare_trees
41
from bzrlib.tree import EmptyTree, RevisionTree
42
from bzrlib.inventory import Inventory
43
from bzrlib.store import copy_all
44
from bzrlib.store.compressed_text import CompressedTextStore
45
from bzrlib.store.text import TextStore
46
from bzrlib.store.weave import WeaveStore
47
import bzrlib.transactions as transactions
48
from bzrlib.transport import Transport, get_transport
53
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
54
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
55
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
56
## TODO: Maybe include checks for common corruption of newlines, etc?
59
# TODO: Some operations like log might retrieve the same revisions
60
# repeatedly to calculate deltas. We could perhaps have a weakref
61
# cache in memory to make this faster. In general anything can be
62
# cached in memory between lock and unlock operations.
64
def find_branch(*ignored, **ignored_too):
65
# XXX: leave this here for about one release, then remove it
66
raise NotImplementedError('find_branch() is not supported anymore, '
67
'please use one of the new branch constructors')
69
######################################################################
73
"""Branch holding a history of revisions.
76
Base directory/url of the branch.
80
def __init__(self, *ignored, **ignored_too):
81
raise NotImplementedError('The Branch class is abstract')
84
def open_downlevel(base):
85
"""Open a branch which may be of an old format.
87
Only local branches are supported."""
88
return _Branch(get_transport(base), relax_version_check=True)
92
"""Open an existing branch, rooted at 'base' (url)"""
93
t = get_transport(base)
94
mutter("trying to open %r with transport %r", base, t)
98
def open_containing(url):
99
"""Open an existing branch which contains url.
101
This probes for a branch at url, and searches upwards from there.
103
Basically we keep looking up until we find the control directory or
104
run into the root. If there isn't one, raises NotBranchError.
106
t = get_transport(url)
110
except NotBranchError:
112
new_t = t.clone('..')
113
if new_t.base == t.base:
114
# reached the root, whatever that may be
115
raise NotBranchError('%s is not in a branch' % url)
119
def initialize(base):
120
"""Create a new branch, rooted at 'base' (url)"""
121
t = get_transport(base)
122
return _Branch(t, init=True)
124
def setup_caching(self, cache_root):
125
"""Subclasses that care about caching should override this, and set
126
up cached stores located under cache_root.
128
self.cache_root = cache_root
131
class _Branch(Branch):
132
"""A branch stored in the actual filesystem.
134
Note that it's "local" in the context of the filesystem; it doesn't
135
really matter if it's on an nfs/smb/afs/coda/... share, as long as
136
it's writable, and can be accessed via the normal filesystem API.
142
If _lock_mode is true, a positive count of the number of times the
146
Lock object from bzrlib.lock.
148
# We actually expect this class to be somewhat short-lived; part of its
149
# purpose is to try to isolate what bits of the branch logic are tied to
150
# filesystem access, so that in a later step, we can extricate them to
151
# a separarte ("storage") class.
155
_inventory_weave = None
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def push_stores(self, branch_to):
163
"""Copy the content of this branches store to branch_to."""
164
if (self._branch_format != branch_to._branch_format
165
or self._branch_format != 4):
166
from bzrlib.fetch import greedy_fetch
167
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
168
self, self._branch_format, branch_to, branch_to._branch_format)
169
greedy_fetch(to_branch=branch_to, from_branch=self,
170
revision=self.last_revision())
173
store_pairs = ((self.text_store, branch_to.text_store),
174
(self.inventory_store, branch_to.inventory_store),
175
(self.revision_store, branch_to.revision_store))
177
for from_store, to_store in store_pairs:
178
copy_all(from_store, to_store)
179
except UnlistableStore:
180
raise UnlistableBranch(from_store)
182
def __init__(self, transport, init=False,
183
relax_version_check=False):
184
"""Create new branch object at a particular location.
186
transport -- A Transport object, defining how to access files.
187
(If a string, transport.transport() will be used to
188
create a Transport object)
190
init -- If True, create new control files in a previously
191
unversioned directory. If False, the branch must already
194
relax_version_check -- If true, the usual check for the branch
195
version is not applied. This is intended only for
196
upgrade/recovery type use; it's not guaranteed that
197
all operations will work on old format branches.
199
In the test suite, creation of new trees is tested using the
200
`ScratchBranch` class.
202
assert isinstance(transport, Transport), \
203
"%r is not a Transport" % transport
204
self._transport = transport
207
self._check_format(relax_version_check)
209
def get_store(name, compressed=True, prefixed=False):
210
# FIXME: This approach of assuming stores are all entirely compressed
211
# or entirely uncompressed is tidy, but breaks upgrade from
212
# some existing branches where there's a mixture; we probably
213
# still want the option to look for both.
214
relpath = self._rel_controlfilename(name)
216
store = CompressedTextStore(self._transport.clone(relpath),
219
store = TextStore(self._transport.clone(relpath),
221
#if self._transport.should_cache():
222
# cache_path = os.path.join(self.cache_root, name)
223
# os.mkdir(cache_path)
224
# store = bzrlib.store.CachedStore(store, cache_path)
226
def get_weave(name, prefixed=False):
227
relpath = self._rel_controlfilename(name)
228
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
229
if self._transport.should_cache():
230
ws.enable_cache = True
233
if self._branch_format == 4:
234
self.inventory_store = get_store('inventory-store')
235
self.text_store = get_store('text-store')
236
self.revision_store = get_store('revision-store')
237
elif self._branch_format == 5:
238
self.control_weaves = get_weave([])
239
self.weave_store = get_weave('weaves')
240
self.revision_store = get_store('revision-store', compressed=False)
241
elif self._branch_format == 6:
242
self.control_weaves = get_weave([])
243
self.weave_store = get_weave('weaves', prefixed=True)
244
self.revision_store = get_store('revision-store', compressed=False,
246
self._transaction = None
249
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
256
if self._lock_mode or self._lock:
257
# XXX: This should show something every time, and be suitable for
258
# headless operation and embedding
259
warn("branch %r was not explicitly unlocked" % self)
262
# TODO: It might be best to do this somewhere else,
263
# but it is nice for a Branch object to automatically
264
# cache it's information.
265
# Alternatively, we could have the Transport objects cache requests
266
# See the earlier discussion about how major objects (like Branch)
267
# should never expect their __del__ function to run.
268
if hasattr(self, 'cache_root') and self.cache_root is not None:
271
shutil.rmtree(self.cache_root)
274
self.cache_root = None
278
return self._transport.base
281
base = property(_get_base, doc="The URL for the root of this branch.")
283
def _finish_transaction(self):
284
"""Exit the current transaction."""
285
if self._transaction is None:
286
raise errors.LockError('Branch %s is not in a transaction' %
288
transaction = self._transaction
289
self._transaction = None
292
def get_transaction(self):
293
"""Return the current active transaction.
295
If no transaction is active, this returns a passthrough object
296
for which all data is immedaitely flushed and no caching happens.
298
if self._transaction is None:
299
return transactions.PassThroughTransaction()
301
return self._transaction
303
def _set_transaction(self, new_transaction):
304
"""Set a new active transaction."""
305
if self._transaction is not None:
306
raise errors.LockError('Branch %s is in a transaction already.' %
308
self._transaction = new_transaction
310
def lock_write(self):
311
mutter("lock write: %s (%s)", self, self._lock_count)
312
# TODO: Upgrade locking to support using a Transport,
313
# and potentially a remote locking protocol
315
if self._lock_mode != 'w':
316
raise LockError("can't upgrade to a write lock from %r" %
318
self._lock_count += 1
320
self._lock = self._transport.lock_write(
321
self._rel_controlfilename('branch-lock'))
322
self._lock_mode = 'w'
324
self._set_transaction(transactions.PassThroughTransaction())
327
mutter("lock read: %s (%s)", self, self._lock_count)
329
assert self._lock_mode in ('r', 'w'), \
330
"invalid lock mode %r" % self._lock_mode
331
self._lock_count += 1
333
self._lock = self._transport.lock_read(
334
self._rel_controlfilename('branch-lock'))
335
self._lock_mode = 'r'
337
self._set_transaction(transactions.ReadOnlyTransaction())
338
# 5K may be excessive, but hey, its a knob.
339
self.get_transaction().set_cache_size(5000)
342
mutter("unlock: %s (%s)", self, self._lock_count)
343
if not self._lock_mode:
344
raise LockError('branch %r is not locked' % (self))
346
if self._lock_count > 1:
347
self._lock_count -= 1
349
self._finish_transaction()
352
self._lock_mode = self._lock_count = None
354
def abspath(self, name):
355
"""Return absolute filename for something in the branch
357
XXX: Robert Collins 20051017 what is this used for? why is it a branch
358
method and not a tree method.
360
return self._transport.abspath(name)
362
def _rel_controlfilename(self, file_or_path):
363
if isinstance(file_or_path, basestring):
364
file_or_path = [file_or_path]
365
return [bzrlib.BZRDIR] + file_or_path
367
def controlfilename(self, file_or_path):
368
"""Return location relative to branch."""
369
return self._transport.abspath(self._rel_controlfilename(file_or_path))
372
def controlfile(self, file_or_path, mode='r'):
373
"""Open a control file for this branch.
375
There are two classes of file in the control directory: text
376
and binary. binary files are untranslated byte streams. Text
377
control files are stored with Unix newlines and in UTF-8, even
378
if the platform or locale defaults are different.
380
Controlfiles should almost never be opened in write mode but
381
rather should be atomically copied and replaced using atomicfile.
385
relpath = self._rel_controlfilename(file_or_path)
386
#TODO: codecs.open() buffers linewise, so it was overloaded with
387
# a much larger buffer, do we need to do the same for getreader/getwriter?
389
return self._transport.get(relpath)
391
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
393
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
395
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
397
raise BzrError("invalid controlfile mode %r" % mode)
399
def put_controlfile(self, path, f, encode=True):
400
"""Write an entry as a controlfile.
402
:param path: The path to put the file, relative to the .bzr control
404
:param f: A file-like or string object whose contents should be copied.
405
:param encode: If true, encode the contents as utf-8
407
self.put_controlfiles([(path, f)], encode=encode)
409
def put_controlfiles(self, files, encode=True):
410
"""Write several entries as controlfiles.
412
:param files: A list of [(path, file)] pairs, where the path is the directory
413
underneath the bzr control directory
414
:param encode: If true, encode the contents as utf-8
418
for path, f in files:
420
if isinstance(f, basestring):
421
f = f.encode('utf-8', 'replace')
423
f = codecs.getwriter('utf-8')(f, errors='replace')
424
path = self._rel_controlfilename(path)
425
ctrl_files.append((path, f))
426
self._transport.put_multi(ctrl_files)
428
def _make_control(self):
429
from bzrlib.inventory import Inventory
430
from bzrlib.weavefile import write_weave_v5
431
from bzrlib.weave import Weave
433
# Create an empty inventory
435
# if we want per-tree root ids then this is the place to set
436
# them; they're not needed for now and so ommitted for
438
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
439
empty_inv = sio.getvalue()
441
bzrlib.weavefile.write_weave_v5(Weave(), sio)
442
empty_weave = sio.getvalue()
444
dirs = [[], 'revision-store', 'weaves']
446
"This is a Bazaar-NG control directory.\n"
447
"Do not change any files in this directory.\n"),
448
('branch-format', BZR_BRANCH_FORMAT_6),
449
('revision-history', ''),
452
('pending-merges', ''),
453
('inventory', empty_inv),
454
('inventory.weave', empty_weave),
455
('ancestry.weave', empty_weave)
457
cfn = self._rel_controlfilename
458
self._transport.mkdir_multi([cfn(d) for d in dirs])
459
self.put_controlfiles(files)
460
mutter('created control directory in ' + self._transport.base)
462
def _check_format(self, relax_version_check):
463
"""Check this branch format is supported.
465
The format level is stored, as an integer, in
466
self._branch_format for code that needs to check it later.
468
In the future, we might need different in-memory Branch
469
classes to support downlevel branches. But not yet.
472
fmt = self.controlfile('branch-format', 'r').read()
474
raise NotBranchError(self.base)
475
mutter("got branch format %r", fmt)
476
if fmt == BZR_BRANCH_FORMAT_6:
477
self._branch_format = 6
478
elif fmt == BZR_BRANCH_FORMAT_5:
479
self._branch_format = 5
480
elif fmt == BZR_BRANCH_FORMAT_4:
481
self._branch_format = 4
483
if (not relax_version_check
484
and self._branch_format not in (5, 6)):
485
raise errors.UnsupportedFormatError(
486
'sorry, branch format %r not supported' % fmt,
487
['use a different bzr version',
488
'or remove the .bzr directory'
489
' and "bzr init" again'])
491
def get_root_id(self):
492
"""Return the id of this branches root"""
493
inv = self.read_working_inventory()
494
return inv.root.file_id
496
def set_root_id(self, file_id):
497
inv = self.read_working_inventory()
498
orig_root_id = inv.root.file_id
499
del inv._byid[inv.root.file_id]
500
inv.root.file_id = file_id
501
inv._byid[inv.root.file_id] = inv.root
504
if entry.parent_id in (None, orig_root_id):
505
entry.parent_id = inv.root.file_id
506
self._write_inventory(inv)
508
def read_working_inventory(self):
509
"""Read the working inventory."""
512
# ElementTree does its own conversion from UTF-8, so open in
514
f = self.controlfile('inventory', 'rb')
515
return bzrlib.xml5.serializer_v5.read_inventory(f)
520
def _write_inventory(self, inv):
521
"""Update the working inventory.
523
That is to say, the inventory describing changes underway, that
524
will be committed to the next revision.
526
from cStringIO import StringIO
530
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
532
# Transport handles atomicity
533
self.put_controlfile('inventory', sio)
537
mutter('wrote working inventory')
539
inventory = property(read_working_inventory, _write_inventory, None,
540
"""Inventory for the working copy.""")
542
def add(self, files, ids=None):
543
"""Make files versioned.
545
Note that the command line normally calls smart_add instead,
546
which can automatically recurse.
548
This puts the files in the Added state, so that they will be
549
recorded by the next commit.
552
List of paths to add, relative to the base of the tree.
555
If set, use these instead of automatically generated ids.
556
Must be the same length as the list of files, but may
557
contain None for ids that are to be autogenerated.
559
TODO: Perhaps have an option to add the ids even if the files do
562
TODO: Perhaps yield the ids and paths as they're added.
564
# TODO: Re-adding a file that is removed in the working copy
565
# should probably put it back with the previous ID.
566
if isinstance(files, basestring):
567
assert(ids is None or isinstance(ids, basestring))
573
ids = [None] * len(files)
575
assert(len(ids) == len(files))
579
inv = self.read_working_inventory()
580
for f,file_id in zip(files, ids):
581
if is_control_file(f):
582
raise BzrError("cannot add control file %s" % quotefn(f))
587
raise BzrError("cannot add top-level %r" % f)
589
fullpath = os.path.normpath(self.abspath(f))
592
kind = file_kind(fullpath)
594
# maybe something better?
595
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
597
if not InventoryEntry.versionable_kind(kind):
598
raise BzrError('cannot add: not a versionable file ('
599
'i.e. regular file, symlink or directory): %s' % quotefn(f))
602
file_id = gen_file_id(f)
603
inv.add_path(f, kind=kind, file_id=file_id)
605
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
607
self._write_inventory(inv)
612
def print_file(self, file, revno):
613
"""Print `file` to stdout."""
616
tree = self.revision_tree(self.get_rev_id(revno))
617
# use inventory as it was in that revision
618
file_id = tree.inventory.path2id(file)
620
raise BzrError("%r is not present in revision %s" % (file, revno))
621
tree.print_file(file_id)
626
def remove(self, files, verbose=False):
627
"""Mark nominated files for removal from the inventory.
629
This does not remove their text. This does not run on
631
TODO: Refuse to remove modified files unless --force is given?
633
TODO: Do something useful with directories.
635
TODO: Should this remove the text or not? Tough call; not
636
removing may be useful and the user can just use use rm, and
637
is the opposite of add. Removing it is consistent with most
638
other tools. Maybe an option.
640
## TODO: Normalize names
641
## TODO: Remove nested loops; better scalability
642
if isinstance(files, basestring):
648
tree = self.working_tree()
651
# do this before any modifications
655
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
656
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
658
# having remove it, it must be either ignored or unknown
659
if tree.is_ignored(f):
663
show_status(new_status, inv[fid].kind, quotefn(f))
666
self._write_inventory(inv)
670
# FIXME: this doesn't need to be a branch method
671
def set_inventory(self, new_inventory_list):
672
from bzrlib.inventory import Inventory, InventoryEntry
673
inv = Inventory(self.get_root_id())
674
for path, file_id, parent, kind in new_inventory_list:
675
name = os.path.basename(path)
678
# fixme, there should be a factory function inv,add_??
679
if kind == 'directory':
680
inv.add(inventory.InventoryDirectory(file_id, name, parent))
682
inv.add(inventory.InventoryFile(file_id, name, parent))
683
elif kind == 'symlink':
684
inv.add(inventory.InventoryLink(file_id, name, parent))
686
raise BzrError("unknown kind %r" % kind)
687
self._write_inventory(inv)
690
"""Return all unknown files.
692
These are files in the working directory that are not versioned or
693
control files or ignored.
695
>>> b = ScratchBranch(files=['foo', 'foo~'])
696
>>> list(b.unknowns())
699
>>> list(b.unknowns())
702
>>> list(b.unknowns())
705
return self.working_tree().unknowns()
708
def append_revision(self, *revision_ids):
709
for revision_id in revision_ids:
710
mutter("add {%s} to revision-history" % revision_id)
713
rev_history = self.revision_history()
714
rev_history.extend(revision_ids)
715
self.put_controlfile('revision-history', '\n'.join(rev_history))
719
def has_revision(self, revision_id):
720
"""True if this branch has a copy of the revision.
722
This does not necessarily imply the revision is merge
723
or on the mainline."""
724
return (revision_id is None
725
or revision_id in self.revision_store)
727
def get_revision_xml_file(self, revision_id):
728
"""Return XML file object for revision object."""
729
if not revision_id or not isinstance(revision_id, basestring):
730
raise InvalidRevisionId(revision_id)
735
return self.revision_store[revision_id]
736
except (IndexError, KeyError):
737
raise bzrlib.errors.NoSuchRevision(self, revision_id)
742
get_revision_xml = get_revision_xml_file
744
def get_revision_xml(self, revision_id):
745
return self.get_revision_xml_file(revision_id).read()
748
def get_revision(self, revision_id):
749
"""Return the Revision object for a named revision"""
750
xml_file = self.get_revision_xml_file(revision_id)
753
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
754
except SyntaxError, e:
755
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
759
assert r.revision_id == revision_id
762
def get_revision_delta(self, revno):
763
"""Return the delta for one revision.
765
The delta is relative to its mainline predecessor, or the
766
empty tree for revision 1.
768
assert isinstance(revno, int)
769
rh = self.revision_history()
770
if not (1 <= revno <= len(rh)):
771
raise InvalidRevisionNumber(revno)
773
# revno is 1-based; list is 0-based
775
new_tree = self.revision_tree(rh[revno-1])
777
old_tree = EmptyTree()
779
old_tree = self.revision_tree(rh[revno-2])
781
return compare_trees(old_tree, new_tree)
783
def get_revision_sha1(self, revision_id):
784
"""Hash the stored value of a revision, and return it."""
785
# In the future, revision entries will be signed. At that
786
# point, it is probably best *not* to include the signature
787
# in the revision hash. Because that lets you re-sign
788
# the revision, (add signatures/remove signatures) and still
789
# have all hash pointers stay consistent.
790
# But for now, just hash the contents.
791
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
793
def get_ancestry(self, revision_id):
794
"""Return a list of revision-ids integrated by a revision.
796
This currently returns a list, but the ordering is not guaranteed:
799
if revision_id is None:
801
w = self.get_inventory_weave()
802
return [None] + map(w.idx_to_name,
803
w.inclusions([w.lookup(revision_id)]))
805
def get_inventory_weave(self):
806
return self.control_weaves.get_weave('inventory',
807
self.get_transaction())
809
def get_inventory(self, revision_id):
810
"""Get Inventory object by hash."""
811
xml = self.get_inventory_xml(revision_id)
812
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
814
def get_inventory_xml(self, revision_id):
815
"""Get inventory XML as a file object."""
817
assert isinstance(revision_id, basestring), type(revision_id)
818
iw = self.get_inventory_weave()
819
return iw.get_text(iw.lookup(revision_id))
821
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
823
def get_inventory_sha1(self, revision_id):
824
"""Return the sha1 hash of the inventory entry
826
return self.get_revision(revision_id).inventory_sha1
828
def get_revision_inventory(self, revision_id):
829
"""Return inventory of a past revision."""
830
# TODO: Unify this with get_inventory()
831
# bzr 0.0.6 and later imposes the constraint that the inventory_id
832
# must be the same as its revision, so this is trivial.
833
if revision_id == None:
834
return Inventory(self.get_root_id())
836
return self.get_inventory(revision_id)
838
def revision_history(self):
839
"""Return sequence of revision hashes on to this branch."""
842
transaction = self.get_transaction()
843
history = transaction.map.find_revision_history()
844
if history is not None:
845
mutter("cache hit for revision-history in %s", self)
847
history = [l.rstrip('\r\n') for l in
848
self.controlfile('revision-history', 'r').readlines()]
849
transaction.map.add_revision_history(history)
850
# this call is disabled because revision_history is
851
# not really an object yet, and the transaction is for objects.
852
# transaction.register_clean(history, precious=True)
858
"""Return current revision number for this branch.
860
That is equivalent to the number of revisions committed to
863
return len(self.revision_history())
866
def last_revision(self):
867
"""Return last patch hash, or None if no history.
869
ph = self.revision_history()
876
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
877
"""Return a list of new revisions that would perfectly fit.
879
If self and other have not diverged, return a list of the revisions
880
present in other, but missing from self.
882
>>> from bzrlib.commit import commit
883
>>> bzrlib.trace.silent = True
884
>>> br1 = ScratchBranch()
885
>>> br2 = ScratchBranch()
886
>>> br1.missing_revisions(br2)
888
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
889
>>> br1.missing_revisions(br2)
891
>>> br2.missing_revisions(br1)
893
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
894
>>> br1.missing_revisions(br2)
896
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
897
>>> br1.missing_revisions(br2)
899
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
900
>>> br1.missing_revisions(br2)
901
Traceback (most recent call last):
902
DivergedBranches: These branches have diverged.
904
self_history = self.revision_history()
905
self_len = len(self_history)
906
other_history = other.revision_history()
907
other_len = len(other_history)
908
common_index = min(self_len, other_len) -1
909
if common_index >= 0 and \
910
self_history[common_index] != other_history[common_index]:
911
raise DivergedBranches(self, other)
913
if stop_revision is None:
914
stop_revision = other_len
916
assert isinstance(stop_revision, int)
917
if stop_revision > other_len:
918
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
919
return other_history[self_len:stop_revision]
921
def update_revisions(self, other, stop_revision=None):
922
"""Pull in new perfect-fit revisions."""
923
# FIXME: If the branches have diverged, but the latest
924
# revision in this branch is completely merged into the other,
925
# then we should still be able to pull.
926
from bzrlib.fetch import greedy_fetch
927
if stop_revision is None:
928
stop_revision = other.last_revision()
929
### Should this be checking is_ancestor instead of revision_history?
930
if (stop_revision is not None and
931
stop_revision in self.revision_history()):
933
greedy_fetch(to_branch=self, from_branch=other,
934
revision=stop_revision)
935
pullable_revs = self.pullable_revisions(other, stop_revision)
936
if len(pullable_revs) > 0:
937
self.append_revision(*pullable_revs)
939
def pullable_revisions(self, other, stop_revision):
940
other_revno = other.revision_id_to_revno(stop_revision)
942
return self.missing_revisions(other, other_revno)
943
except DivergedBranches, e:
945
pullable_revs = get_intervening_revisions(self.last_revision(),
947
assert self.last_revision() not in pullable_revs
949
except bzrlib.errors.NotAncestor:
950
if is_ancestor(self.last_revision(), stop_revision, self):
956
def commit(self, *args, **kw):
957
from bzrlib.commit import Commit
958
Commit().commit(self, *args, **kw)
960
def revision_id_to_revno(self, revision_id):
961
"""Given a revision id, return its revno"""
962
if revision_id is None:
964
history = self.revision_history()
966
return history.index(revision_id) + 1
968
raise bzrlib.errors.NoSuchRevision(self, revision_id)
970
def get_rev_id(self, revno, history=None):
971
"""Find the revision id of the specified revno."""
975
history = self.revision_history()
976
elif revno <= 0 or revno > len(history):
977
raise bzrlib.errors.NoSuchRevision(self, revno)
978
return history[revno - 1]
980
def revision_tree(self, revision_id):
981
"""Return Tree for a revision on this branch.
983
`revision_id` may be None for the null revision, in which case
984
an `EmptyTree` is returned."""
985
# TODO: refactor this to use an existing revision object
986
# so we don't need to read it in twice.
987
if revision_id == None:
990
inv = self.get_revision_inventory(revision_id)
991
return RevisionTree(self.weave_store, inv, revision_id)
994
def working_tree(self):
995
"""Return a `Tree` for the working copy."""
996
from bzrlib.workingtree import WorkingTree
997
# TODO: In the future, WorkingTree should utilize Transport
998
# RobertCollins 20051003 - I don't think it should - working trees are
999
# much more complex to keep consistent than our careful .bzr subset.
1000
# instead, we should say that working trees are local only, and optimise
1002
return WorkingTree(self.base, branch=self)
1005
def basis_tree(self):
1006
"""Return `Tree` object for last revision.
1008
If there are no revisions yet, return an `EmptyTree`.
1010
return self.revision_tree(self.last_revision())
1013
def rename_one(self, from_rel, to_rel):
1016
This can change the directory or the filename or both.
1020
tree = self.working_tree()
1021
inv = tree.inventory
1022
if not tree.has_filename(from_rel):
1023
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1024
if tree.has_filename(to_rel):
1025
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1027
file_id = inv.path2id(from_rel)
1029
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1031
if inv.path2id(to_rel):
1032
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1034
to_dir, to_tail = os.path.split(to_rel)
1035
to_dir_id = inv.path2id(to_dir)
1036
if to_dir_id == None and to_dir != '':
1037
raise BzrError("can't determine destination directory id for %r" % to_dir)
1039
mutter("rename_one:")
1040
mutter(" file_id {%s}" % file_id)
1041
mutter(" from_rel %r" % from_rel)
1042
mutter(" to_rel %r" % to_rel)
1043
mutter(" to_dir %r" % to_dir)
1044
mutter(" to_dir_id {%s}" % to_dir_id)
1046
inv.rename(file_id, to_dir_id, to_tail)
1048
from_abs = self.abspath(from_rel)
1049
to_abs = self.abspath(to_rel)
1051
rename(from_abs, to_abs)
1053
raise BzrError("failed to rename %r to %r: %s"
1054
% (from_abs, to_abs, e[1]),
1055
["rename rolled back"])
1057
self._write_inventory(inv)
1062
def move(self, from_paths, to_name):
1065
to_name must exist as a versioned directory.
1067
If to_name exists and is a directory, the files are moved into
1068
it, keeping their old names. If it is a directory,
1070
Note that to_name is only the last component of the new name;
1071
this doesn't change the directory.
1073
This returns a list of (from_path, to_path) pairs for each
1074
entry that is moved.
1079
## TODO: Option to move IDs only
1080
assert not isinstance(from_paths, basestring)
1081
tree = self.working_tree()
1082
inv = tree.inventory
1083
to_abs = self.abspath(to_name)
1084
if not isdir(to_abs):
1085
raise BzrError("destination %r is not a directory" % to_abs)
1086
if not tree.has_filename(to_name):
1087
raise BzrError("destination %r not in working directory" % to_abs)
1088
to_dir_id = inv.path2id(to_name)
1089
if to_dir_id == None and to_name != '':
1090
raise BzrError("destination %r is not a versioned directory" % to_name)
1091
to_dir_ie = inv[to_dir_id]
1092
if to_dir_ie.kind not in ('directory', 'root_directory'):
1093
raise BzrError("destination %r is not a directory" % to_abs)
1095
to_idpath = inv.get_idpath(to_dir_id)
1097
for f in from_paths:
1098
if not tree.has_filename(f):
1099
raise BzrError("%r does not exist in working tree" % f)
1100
f_id = inv.path2id(f)
1102
raise BzrError("%r is not versioned" % f)
1103
name_tail = splitpath(f)[-1]
1104
dest_path = appendpath(to_name, name_tail)
1105
if tree.has_filename(dest_path):
1106
raise BzrError("destination %r already exists" % dest_path)
1107
if f_id in to_idpath:
1108
raise BzrError("can't move %r to a subdirectory of itself" % f)
1110
# OK, so there's a race here, it's possible that someone will
1111
# create a file in this interval and then the rename might be
1112
# left half-done. But we should have caught most problems.
1114
for f in from_paths:
1115
name_tail = splitpath(f)[-1]
1116
dest_path = appendpath(to_name, name_tail)
1117
result.append((f, dest_path))
1118
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1120
rename(self.abspath(f), self.abspath(dest_path))
1122
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1123
["rename rolled back"])
1125
self._write_inventory(inv)
1132
def revert(self, filenames, old_tree=None, backups=True):
1133
"""Restore selected files to the versions from a previous tree.
1136
If true (default) backups are made of files before
1139
from bzrlib.errors import NotVersionedError, BzrError
1140
from bzrlib.atomicfile import AtomicFile
1141
from bzrlib.osutils import backup_file
1143
inv = self.read_working_inventory()
1144
if old_tree is None:
1145
old_tree = self.basis_tree()
1146
old_inv = old_tree.inventory
1149
for fn in filenames:
1150
file_id = inv.path2id(fn)
1152
raise NotVersionedError("not a versioned file", fn)
1153
if not old_inv.has_id(file_id):
1154
raise BzrError("file not present in old tree", fn, file_id)
1155
nids.append((fn, file_id))
1157
# TODO: Rename back if it was previously at a different location
1159
# TODO: If given a directory, restore the entire contents from
1160
# the previous version.
1162
# TODO: Make a backup to a temporary file.
1164
# TODO: If the file previously didn't exist, delete it?
1165
for fn, file_id in nids:
1168
f = AtomicFile(fn, 'wb')
1170
f.write(old_tree.get_file(file_id).read())
1176
def pending_merges(self):
1177
"""Return a list of pending merges.
1179
These are revisions that have been merged into the working
1180
directory but not yet committed.
1182
cfn = self._rel_controlfilename('pending-merges')
1183
if not self._transport.has(cfn):
1186
for l in self.controlfile('pending-merges', 'r').readlines():
1187
p.append(l.rstrip('\n'))
1191
def add_pending_merge(self, *revision_ids):
1192
# TODO: Perhaps should check at this point that the
1193
# history of the revision is actually present?
1194
p = self.pending_merges()
1196
for rev_id in revision_ids:
1202
self.set_pending_merges(p)
1204
def set_pending_merges(self, rev_list):
1207
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1212
def get_parent(self):
1213
"""Return the parent location of the branch.
1215
This is the default location for push/pull/missing. The usual
1216
pattern is that the user can override it by specifying a
1220
_locs = ['parent', 'pull', 'x-pull']
1223
return self.controlfile(l, 'r').read().strip('\n')
1225
if e.errno != errno.ENOENT:
1230
def set_parent(self, url):
1231
# TODO: Maybe delete old location files?
1232
from bzrlib.atomicfile import AtomicFile
1235
f = AtomicFile(self.controlfilename('parent'))
1244
def check_revno(self, revno):
1246
Check whether a revno corresponds to any revision.
1247
Zero (the NULL revision) is considered valid.
1250
self.check_real_revno(revno)
1252
def check_real_revno(self, revno):
1254
Check whether a revno corresponds to a real revision.
1255
Zero (the NULL revision) is considered invalid
1257
if revno < 1 or revno > self.revno():
1258
raise InvalidRevisionNumber(revno)
1264
class ScratchBranch(_Branch):
1265
"""Special test class: a branch that cleans up after itself.
1267
>>> b = ScratchBranch()
1275
def __init__(self, files=[], dirs=[], base=None):
1276
"""Make a test branch.
1278
This creates a temporary directory and runs init-tree in it.
1280
If any files are listed, they are created in the working copy.
1282
from tempfile import mkdtemp
1287
if isinstance(base, basestring):
1288
base = get_transport(base)
1289
_Branch.__init__(self, base, init=init)
1291
self._transport.mkdir(d)
1294
self._transport.put(f, 'content of %s' % f)
1299
>>> orig = ScratchBranch(files=["file1", "file2"])
1300
>>> clone = orig.clone()
1301
>>> if os.name != 'nt':
1302
... os.path.samefile(orig.base, clone.base)
1304
... orig.base == clone.base
1307
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1310
from shutil import copytree
1311
from tempfile import mkdtemp
1314
copytree(self.base, base, symlinks=True)
1315
return ScratchBranch(base=base)
1321
"""Destroy the test branch, removing the scratch directory."""
1322
from shutil import rmtree
1325
mutter("delete ScratchBranch %s" % self.base)
1328
# Work around for shutil.rmtree failing on Windows when
1329
# readonly files are encountered
1330
mutter("hit exception in destroying ScratchBranch: %s" % e)
1331
for root, dirs, files in os.walk(self.base, topdown=False):
1333
os.chmod(os.path.join(root, name), 0700)
1335
self._transport = None
1339
######################################################################
1343
def is_control_file(filename):
1344
## FIXME: better check
1345
filename = os.path.normpath(filename)
1346
while filename != '':
1347
head, tail = os.path.split(filename)
1348
## mutter('check %r for control file' % ((head, tail), ))
1349
if tail == bzrlib.BZRDIR:
1351
if filename == head:
1358
def gen_file_id(name):
1359
"""Return new file id.
1361
This should probably generate proper UUIDs, but for the moment we
1362
cope with just randomness because running uuidgen every time is
1365
from binascii import hexlify
1366
from time import time
1368
# get last component
1369
idx = name.rfind('/')
1371
name = name[idx+1 : ]
1372
idx = name.rfind('\\')
1374
name = name[idx+1 : ]
1376
# make it not a hidden file
1377
name = name.lstrip('.')
1379
# remove any wierd characters; we don't escape them but rather
1380
# just pull them out
1381
name = re.sub(r'[^\w.]', '', name)
1383
s = hexlify(rand_bytes(8))
1384
return '-'.join((name, compact_date(time()), s))
1388
"""Return a new tree-root file id."""
1389
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
