15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
19
from cStringIO import StringIO
24
from unittest import TestSuite
25
from warnings import warn
27
import xml.sax.saxutils
29
raise ImportError("We were unable to import 'xml.sax.saxutils',"
30
" most likely you have an xml.pyc or xml.pyo file"
31
" lying around in your bzrlib directory."
36
import bzrlib.bzrdir as bzrdir
37
from bzrlib.config import TreeConfig
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.delta import compare_trees
40
import bzrlib.errors as errors
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
42
NoSuchRevision, HistoryMissing, NotBranchError,
43
DivergedBranches, LockError,
44
UninitializableFormat,
46
UnlistableBranch, NoSuchFile, NotVersionedError,
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles
51
from bzrlib.osutils import (isdir, quotefn,
52
rename, splitpath, sha_file,
53
file_kind, abspath, normpath, pathjoin,
56
from bzrlib.textui import show_status
22
57
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
sha_file, appendpath, file_kind
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
28
from bzrlib.textui import show_status
29
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
35
## TODO: Maybe include checks for common corruption of newlines, etc?
58
from bzrlib.tree import EmptyTree, RevisionTree
59
from bzrlib.repository import Repository
60
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
61
from bzrlib.store import copy_all
62
from bzrlib.symbol_versioning import *
63
import bzrlib.transactions as transactions
64
from bzrlib.transport import Transport, get_transport
65
from bzrlib.tree import EmptyTree, RevisionTree
70
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
71
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
72
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
75
# TODO: Maybe include checks for common corruption of newlines, etc?
38
77
# TODO: Some operations like log might retrieve the same revisions
39
78
# repeatedly to calculate deltas. We could perhaps have a weakref
40
# cache in memory to make this faster.
43
def find_branch(f, **args):
44
if f and (f.startswith('http://') or f.startswith('https://')):
46
return remotebranch.RemoteBranch(f, **args)
48
return Branch(f, **args)
51
def find_cached_branch(f, cache_root, **args):
52
from remotebranch import RemoteBranch
53
br = find_branch(f, **args)
54
def cacheify(br, store_name):
55
from meta_store import CachedStore
56
cache_path = os.path.join(cache_root, store_name)
58
new_store = CachedStore(getattr(br, store_name), cache_path)
59
setattr(br, store_name, new_store)
61
if isinstance(br, RemoteBranch):
62
cacheify(br, 'inventory_store')
63
cacheify(br, 'text_store')
64
cacheify(br, 'revision_store')
68
def _relpath(base, path):
69
"""Return path relative to base, or raise exception.
71
The path may be either an absolute path or a path relative to the
72
current working directory.
74
Lifted out of Branch.relpath for ease of testing.
76
os.path.commonprefix (python2.4) has a bad bug that it works just
77
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
78
avoids that problem."""
79
rp = os.path.abspath(path)
83
while len(head) >= len(base):
86
head, tail = os.path.split(head)
90
from errors import NotBranchError
91
raise NotBranchError("path %r is not within branch %r" % (rp, base))
96
def find_branch_root(f=None):
97
"""Find the branch root enclosing f, or pwd.
99
f may be a filename or a URL.
101
It is not necessary that f exists.
103
Basically we keep looking up until we find the control directory or
104
run into the root."""
107
elif hasattr(os.path, 'realpath'):
108
f = os.path.realpath(f)
110
f = os.path.abspath(f)
111
if not os.path.exists(f):
112
raise BzrError('%r does not exist' % f)
118
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
120
head, tail = os.path.split(f)
122
# reached the root, whatever that may be
123
raise BzrError('%r is not in a branch' % orig_f)
126
class DivergedBranches(Exception):
127
def __init__(self, branch1, branch2):
128
self.branch1 = branch1
129
self.branch2 = branch2
130
Exception.__init__(self, "These branches have diverged.")
79
# cache in memory to make this faster. In general anything can be
80
# cached in memory between lock and unlock operations. .. nb thats
81
# what the transaction identity map provides
133
84
######################################################################
137
88
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
91
Base directory/url of the branch.
93
# this is really an instance variable - FIXME move it there
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 __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
99
"""Construct the current default format branch in a_bzrdir.
101
This creates the current default BzrDir format, and if that
102
supports multiple Branch formats, then the default Branch format
105
print "not usable until we have repositories"
106
raise NotImplementedError("not usable right now")
107
return bzrdir.BzrDir.create(base)
109
def __init__(self, *ignored, **ignored_too):
110
raise NotImplementedError('The Branch class is abstract')
113
@deprecated_method(zero_eight)
114
def open_downlevel(base):
115
"""Open a branch which may be of an old format."""
116
return Branch.open(base, _unsupported=True)
119
def open(base, _unsupported=False):
120
"""Open the repository rooted at base.
122
For instance, if the repository is at URL/.bzr/repository,
123
Repository.open(URL) -> a Repository instance.
125
control = bzrdir.BzrDir.open(base, _unsupported)
126
return control.open_branch(_unsupported)
129
def open_containing(url):
130
"""Open an existing branch which contains url.
132
This probes for a branch at url, and searches upwards from there.
134
Basically we keep looking up until we find the control directory or
135
run into the root. If there isn't one, raises NotBranchError.
136
If there is one and it is either an unrecognised format or an unsupported
137
format, UnknownFormatError or UnsupportedFormatError are raised.
138
If there is one, it is returned, along with the unused portion of url.
140
control, relpath = bzrdir.BzrDir.open_containing(url)
141
return control.open_branch(), relpath
144
@deprecated_function(zero_eight)
145
def initialize(base):
146
"""Create a new working tree and branch, rooted at 'base' (url)
148
NOTE: This will soon be deprecated in favour of creation
151
# imported here to prevent scope creep as this is going.
152
from bzrlib.workingtree import WorkingTree
153
return WorkingTree.create_standalone(safe_unicode(base)).branch
155
def setup_caching(self, cache_root):
156
"""Subclasses that care about caching should override this, and set
157
up cached stores located under cache_root.
159
# seems to be unused, 2006-01-13 mbp
160
warn('%s is deprecated' % self.setup_caching)
161
self.cache_root = cache_root
164
cfg = self.tree_config()
165
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
167
def _set_nick(self, nick):
168
cfg = self.tree_config()
169
cfg.set_option(nick, "nickname")
170
assert cfg.get_option("nickname") == nick
172
nick = property(_get_nick, _set_nick)
212
174
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
175
raise NotImplementedError('lock_write is abstract')
228
177
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
178
raise NotImplementedError('lock_read is abstract')
242
180
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
252
self._lock_mode = self._lock_count = None
181
raise NotImplementedError('unlock is abstract')
183
def peek_lock_mode(self):
184
"""Return lock mode for the Branch: 'r', 'w' or None"""
185
raise NotImplementedError(self.peek_lock_mode)
255
187
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
188
"""Return absolute filename for something in the branch
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
190
XXX: Robert Collins 20051017 what is this used for? why is it a branch
191
method and not a tree method.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
193
raise NotImplementedError('abspath is abstract')
340
195
def get_root_id(self):
341
196
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
197
raise NotImplementedError('get_root_id is abstract')
199
def print_file(self, file, revision_id):
480
200
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
201
raise NotImplementedError('print_file is abstract')
569
203
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
assert r.revision_id == revision_id
617
def get_revision_delta(self, revno):
618
"""Return the delta for one revision.
620
The delta is relative to its mainline predecessor, or the
621
empty tree for revision 1.
623
assert isinstance(revno, int)
624
rh = self.revision_history()
625
if not (1 <= revno <= len(rh)):
626
raise InvalidRevisionNumber(revno)
628
# revno is 1-based; list is 0-based
630
new_tree = self.revision_tree(rh[revno-1])
632
old_tree = EmptyTree()
634
old_tree = self.revision_tree(rh[revno-2])
636
return compare_trees(old_tree, new_tree)
640
def get_revision_sha1(self, revision_id):
641
"""Hash the stored value of a revision, and return it."""
642
# In the future, revision entries will be signed. At that
643
# point, it is probably best *not* to include the signature
644
# in the revision hash. Because that lets you re-sign
645
# the revision, (add signatures/remove signatures) and still
646
# have all hash pointers stay consistent.
647
# But for now, just hash the contents.
648
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
651
def get_inventory(self, inventory_id):
652
"""Get Inventory object by hash.
654
TODO: Perhaps for this and similar methods, take a revision
655
parameter which can be either an integer revno or a
657
from bzrlib.inventory import Inventory
658
from bzrlib.xml import unpack_xml
660
return unpack_xml(Inventory, self.inventory_store[inventory_id])
663
def get_inventory_sha1(self, inventory_id):
664
"""Return the sha1 hash of the inventory entry
666
return sha_file(self.inventory_store[inventory_id])
669
def get_revision_inventory(self, revision_id):
670
"""Return inventory of a past revision."""
671
# bzr 0.0.6 imposes the constraint that the inventory_id
672
# must be the same as its revision, so this is trivial.
673
if revision_id == None:
674
from bzrlib.inventory import Inventory
675
return Inventory(self.get_root_id())
677
return self.get_inventory(revision_id)
204
raise NotImplementedError('append_revision is abstract')
206
def set_revision_history(self, rev_history):
207
raise NotImplementedError('set_revision_history is abstract')
680
209
def revision_history(self):
681
"""Return sequence of revision hashes on to this branch.
683
>>> ScratchBranch().revision_history()
688
return [l.rstrip('\r\n') for l in
689
self.controlfile('revision-history', 'r').readlines()]
694
def common_ancestor(self, other, self_revno=None, other_revno=None):
697
>>> sb = ScratchBranch(files=['foo', 'foo~'])
698
>>> sb.common_ancestor(sb) == (None, None)
700
>>> commit.commit(sb, "Committing first revision", verbose=False)
701
>>> sb.common_ancestor(sb)[0]
703
>>> clone = sb.clone()
704
>>> commit.commit(sb, "Committing second revision", verbose=False)
705
>>> sb.common_ancestor(sb)[0]
707
>>> sb.common_ancestor(clone)[0]
709
>>> commit.commit(clone, "Committing divergent second revision",
711
>>> sb.common_ancestor(clone)[0]
713
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
715
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
717
>>> clone2 = sb.clone()
718
>>> sb.common_ancestor(clone2)[0]
720
>>> sb.common_ancestor(clone2, self_revno=1)[0]
722
>>> sb.common_ancestor(clone2, other_revno=1)[0]
725
my_history = self.revision_history()
726
other_history = other.revision_history()
727
if self_revno is None:
728
self_revno = len(my_history)
729
if other_revno is None:
730
other_revno = len(other_history)
731
indices = range(min((self_revno, other_revno)))
734
if my_history[r] == other_history[r]:
735
return r+1, my_history[r]
210
"""Return sequence of revision hashes on to this branch."""
211
raise NotImplementedError('revision_history is abstract')
740
214
"""Return current revision number for this branch.
794
270
if stop_revision is None:
795
271
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
273
assert isinstance(stop_revision, int)
274
if stop_revision > other_len:
275
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
276
return other_history[self_len:stop_revision]
802
278
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
816
>>> br2.revision_history()
818
>>> br2.update_revisions(br1)
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
825
from bzrlib.progress import ProgressBar
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
842
for rev_id in revision_ids:
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
891
try:# Convert to int if possible
892
revision = int(revision)
895
revs = self.revision_history()
896
if isinstance(revision, int):
899
# Mabye we should do this first, but we don't need it if revision == 0
901
revno = len(revs) + revision + 1
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
910
raise BzrError('No namespace registered for string: %r' % revision)
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
920
return int(revision[6:])
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
928
return revs.index(revision[6:]) + 1
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
936
offset = int(revision[5:])
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
953
# Spec for date revisions:
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
996
year, month, day = today.year, today.month, today.day
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1005
hour, minute, second = 0,0,0
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1012
if match_style == '-':
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
279
"""Pull in new perfect-fit revisions."""
280
raise NotImplementedError('update_revisions is abstract')
282
def pullable_revisions(self, other, stop_revision):
283
raise NotImplementedError('pullable_revisions is abstract')
285
def revision_id_to_revno(self, revision_id):
286
"""Given a revision id, return its revno"""
287
if revision_id is None:
289
history = self.revision_history()
291
return history.index(revision_id) + 1
293
raise bzrlib.errors.NoSuchRevision(self, revision_id)
295
def get_rev_id(self, revno, history=None):
296
"""Find the revision id of the specified revno."""
300
history = self.revision_history()
301
elif revno <= 0 or revno > len(history):
302
raise bzrlib.errors.NoSuchRevision(self, revno)
303
return history[revno - 1]
305
def pull(self, source, overwrite=False):
306
raise NotImplementedError('pull is abstract')
1053
308
def basis_tree(self):
1054
309
"""Return `Tree` object for last revision.
1056
311
If there are no revisions yet, return an `EmptyTree`.
1058
r = self.last_patch()
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
313
return self.repository.revision_tree(self.last_revision())
1066
315
def rename_one(self, from_rel, to_rel):
1067
316
"""Rename one file.
1069
318
This can change the directory or the filename or both.
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1080
file_id = inv.path2id(from_rel)
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1099
inv.rename(file_id, to_dir_id, to_tail)
1101
print "%s => %s" % (from_rel, to_rel)
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1106
os.rename(from_abs, to_abs)
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1112
self._write_inventory(inv)
320
raise NotImplementedError('rename_one is abstract')
1117
322
def move(self, from_paths, to_name):
1118
323
"""Rename files.
1125
330
Note that to_name is only the last component of the new name;
1126
331
this doesn't change the directory.
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1146
to_idpath = inv.get_idpath(to_dir_id)
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1176
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
333
This returns a list of (from_path, to_path) pairs for each
336
raise NotImplementedError('move is abstract')
338
def get_parent(self):
339
"""Return the parent location of the branch.
341
This is the default location for push/pull/missing. The usual
342
pattern is that the user can override it by specifying a
345
raise NotImplementedError('get_parent is abstract')
347
def get_push_location(self):
348
"""Return the None or the location to push this branch to."""
349
raise NotImplementedError('get_push_location is abstract')
351
def set_push_location(self, location):
352
"""Set a new push location for this branch."""
353
raise NotImplementedError('set_push_location is abstract')
355
def set_parent(self, url):
356
raise NotImplementedError('set_parent is abstract')
358
def check_revno(self, revno):
360
Check whether a revno corresponds to any revision.
361
Zero (the NULL revision) is considered valid.
364
self.check_real_revno(revno)
366
def check_real_revno(self, revno):
368
Check whether a revno corresponds to a real revision.
369
Zero (the NULL revision) is considered invalid
371
if revno < 1 or revno > self.revno():
372
raise InvalidRevisionNumber(revno)
374
def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
375
"""Copy this branch into the existing directory to_location.
377
Returns the newly created branch object.
380
If not None, only revisions up to this point will be copied.
381
The head of the new branch will be that revision. Must be a
384
to_location -- The destination directory; must either exist and be
385
empty, or not exist, in which case it is created.
388
A local branch to copy revisions from, related to this branch.
389
This is used when branching from a remote (slow) branch, and we have
390
a local branch that might contain some relevant revisions.
393
Branch type of destination branch
395
from bzrlib.workingtree import WorkingTree
396
assert isinstance(to_location, basestring)
397
segments = to_location.split('/')
398
if segments and segments[-1] not in ('', '.'):
399
parent = '/'.join(segments[:-1])
400
t = get_transport(parent)
402
t.mkdir(segments[-1])
403
except errors.FileExists:
405
if to_branch_format is None:
407
br_to = bzrdir.BzrDir.create_branch_and_repo(to_location)
409
br_to = to_branch_format.initialize(to_location)
410
mutter("copy branch from %s to %s", self, br_to)
412
revision = self.last_revision()
413
if basis_branch is not None:
414
basis_branch.repository.push_stores(br_to.repository,
416
br_to.update_revisions(self, stop_revision=revision)
417
br_to.set_parent(self.base)
422
class BranchFormat(object):
423
"""An encapsulation of the initialization and open routines for a format.
425
Formats provide three things:
426
* An initialization routine,
430
Formats are placed in an dict by their format string for reference
431
during branch opening. Its not required that these be instances, they
432
can be classes themselves with class methods - it simply depends on
433
whether state is needed for a given format or not.
435
Once a format is deprecated, just deprecate the initialize and open
436
methods on the format class. Do not deprecate the object, as the
437
object will be created every time regardless.
440
_default_format = None
441
"""The default format used for new branches."""
444
"""The known formats."""
447
def find_format(klass, a_bzrdir):
448
"""Return the format for the branch object in a_bzrdir."""
450
transport = a_bzrdir.get_branch_transport(None)
451
format_string = transport.get("format").read()
452
return klass._formats[format_string]
454
raise NotBranchError(path=transport.base)
456
raise errors.UnknownFormatError(format_string)
459
def get_default_format(klass):
460
"""Return the current default format."""
461
return klass._default_format
463
def get_format_string(self):
464
"""Return the ASCII format string that identifies this format."""
465
raise NotImplementedError(self.get_format_string)
467
def _find_modes(self, t):
468
"""Determine the appropriate modes for files and directories.
470
FIXME: When this merges into, or from storage,
471
this code becomes delgatable to a LockableFiles instance.
473
For now its cribbed and returns (dir_mode, file_mode)
477
except errors.TransportNotPossible:
481
dir_mode = st.st_mode & 07777
482
# Remove the sticky and execute bits for files
483
file_mode = dir_mode & ~07111
484
if not BzrBranch._set_dir_mode:
486
if not BzrBranch._set_file_mode:
488
return dir_mode, file_mode
490
def initialize(self, a_bzrdir):
491
"""Create a branch of this format in a_bzrdir."""
492
raise NotImplementedError(self.initialized)
494
def is_supported(self):
495
"""Is this format supported?
497
Supported formats can be initialized and opened.
498
Unsupported formats may not support initialization or committing or
499
some other features depending on the reason for not being supported.
503
def open(self, a_bzrdir, _found=False):
504
"""Return the branch object for a_bzrdir
506
_found is a private parameter, do not use it. It is used to indicate
507
if format probing has already be done.
509
raise NotImplementedError(self.open)
512
def register_format(klass, format):
513
klass._formats[format.get_format_string()] = format
516
def set_default_format(klass, format):
517
klass._default_format = format
520
def unregister_format(klass, format):
521
assert klass._formats[format.get_format_string()] is format
522
del klass._formats[format.get_format_string()]
525
class BzrBranchFormat4(BranchFormat):
526
"""Bzr branch format 4.
529
- a revision-history file.
530
- a branch-lock lock file [ to be shared with the bzrdir ]
533
def initialize(self, a_bzrdir):
534
"""Create a branch of this format in a_bzrdir."""
535
mutter('creating branch in %s', a_bzrdir.transport.base)
536
branch_transport = a_bzrdir.get_branch_transport(self)
537
utf8_files = [('revision-history', ''),
540
control_files = LockableFiles(branch_transport, 'branch-lock')
541
control_files.lock_write()
543
for file, content in utf8_files:
544
control_files.put_utf8(file, content)
546
control_files.unlock()
547
return self.open(a_bzrdir, _found=True)
550
super(BzrBranchFormat4, self).__init__()
551
self._matchingbzrdir = bzrdir.BzrDirFormat6()
553
def open(self, a_bzrdir, _found=False):
554
"""Return the branch object for a_bzrdir
556
_found is a private parameter, do not use it. It is used to indicate
557
if format probing has already be done.
560
# we are being called directly and must probe.
561
raise NotImplementedError
562
transport = a_bzrdir.get_branch_transport(self)
563
control_files = LockableFiles(transport, 'branch-lock')
564
return BzrBranch(_format=self,
565
_control_files=control_files,
569
class BzrBranchFormat5(BranchFormat):
570
"""Bzr branch format 5.
573
- a revision-history file.
578
def get_format_string(self):
579
"""See BranchFormat.get_format_string()."""
580
return "Bazaar-NG branch format 5\n"
582
def initialize(self, a_bzrdir):
583
"""Create a branch of this format in a_bzrdir."""
584
mutter('creating branch in %s', a_bzrdir.transport.base)
585
branch_transport = a_bzrdir.get_branch_transport(self)
587
utf8_files = [('revision-history', ''),
591
branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
592
control_files = LockableFiles(branch_transport, 'lock')
593
control_files.lock_write()
594
control_files.put_utf8('format', self.get_format_string())
596
for file, content in utf8_files:
597
control_files.put_utf8(file, content)
599
control_files.unlock()
600
return self.open(a_bzrdir, _found=True, )
603
super(BzrBranchFormat5, self).__init__()
604
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
606
def open(self, a_bzrdir, _found=False):
607
"""Return the branch object for a_bzrdir
609
_found is a private parameter, do not use it. It is used to indicate
610
if format probing has already be done.
613
format = BranchFormat.find_format(a_bzrdir)
614
assert format.__class__ == self.__class__
615
transport = a_bzrdir.get_branch_transport(None)
616
control_files = LockableFiles(transport, 'lock')
617
return BzrBranch(_format=self,
618
_control_files=control_files,
622
# formats which have no format string are not discoverable
623
# and not independently creatable, so are not registered.
624
__default_format = BzrBranchFormat5()
625
BranchFormat.register_format(__default_format)
626
BranchFormat.set_default_format(__default_format)
627
_legacy_formats = [BzrBranchFormat4(),
630
class BzrBranch(Branch):
631
"""A branch stored in the actual filesystem.
633
Note that it's "local" in the context of the filesystem; it doesn't
634
really matter if it's on an nfs/smb/afs/coda/... share, as long as
635
it's writable, and can be accessed via the normal filesystem API.
638
# We actually expect this class to be somewhat short-lived; part of its
639
# purpose is to try to isolate what bits of the branch logic are tied to
640
# filesystem access, so that in a later step, we can extricate them to
641
# a separarte ("storage") class.
642
_inventory_weave = None
644
# Map some sort of prefix into a namespace
645
# stuff like "revno:10", "revid:", etc.
646
# This should match a prefix with a function which accepts
647
REVISION_NAMESPACES = {}
649
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
650
relax_version_check=DEPRECATED_PARAMETER, _format=None,
651
_control_files=None, a_bzrdir=None):
652
"""Create new branch object at a particular location.
654
transport -- A Transport object, defining how to access files.
656
init -- If True, create new control files in a previously
657
unversioned directory. If False, the branch must already
660
relax_version_check -- If true, the usual check for the branch
661
version is not applied. This is intended only for
662
upgrade/recovery type use; it's not guaranteed that
663
all operations will work on old format branches.
666
self.bzrdir = bzrdir.BzrDir.open(transport.base)
668
self.bzrdir = a_bzrdir
669
self._transport = self.bzrdir.transport.clone('..')
670
self._base = self._transport.base
671
self._format = _format
672
if _control_files is None:
673
raise BzrBadParameterMissing('_control_files')
674
self.control_files = _control_files
675
if deprecated_passed(init):
676
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
677
"deprecated as of bzr 0.8. Please use Branch.create().",
681
# this is slower than before deprecation, oh well never mind.
683
self._initialize(transport.base)
684
self._check_format(_format)
685
if deprecated_passed(relax_version_check):
686
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
687
"relax_version_check parameter is deprecated as of bzr 0.8. "
688
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
692
if (not relax_version_check
693
and not self._format.is_supported()):
694
raise errors.UnsupportedFormatError(
695
'sorry, branch format %r not supported' % fmt,
696
['use a different bzr version',
697
'or remove the .bzr directory'
698
' and "bzr init" again'])
699
if deprecated_passed(transport):
700
warn("BzrBranch.__init__(transport=XXX...): The transport "
701
"parameter is deprecated as of bzr 0.8. "
702
"Please use Branch.open, or bzrdir.open_branch().",
705
self.repository = self.bzrdir.open_repository()
708
return '%s(%r)' % (self.__class__.__name__, self.base)
713
# TODO: It might be best to do this somewhere else,
714
# but it is nice for a Branch object to automatically
715
# cache it's information.
716
# Alternatively, we could have the Transport objects cache requests
717
# See the earlier discussion about how major objects (like Branch)
718
# should never expect their __del__ function to run.
719
# XXX: cache_root seems to be unused, 2006-01-13 mbp
720
if hasattr(self, 'cache_root') and self.cache_root is not None:
722
shutil.rmtree(self.cache_root)
725
self.cache_root = None
730
base = property(_get_base, doc="The URL for the root of this branch.")
732
def _finish_transaction(self):
733
"""Exit the current transaction."""
734
return self.control_files._finish_transaction()
736
def get_transaction(self):
737
"""Return the current active transaction.
739
If no transaction is active, this returns a passthrough object
740
for which all data is immediately flushed and no caching happens.
742
# this is an explicit function so that we can do tricky stuff
743
# when the storage in rev_storage is elsewhere.
744
# we probably need to hook the two 'lock a location' and
745
# 'have a transaction' together more delicately, so that
746
# we can have two locks (branch and storage) and one transaction
747
# ... and finishing the transaction unlocks both, but unlocking
748
# does not. - RBC 20051121
749
return self.control_files.get_transaction()
751
def _set_transaction(self, transaction):
752
"""Set a new active transaction."""
753
return self.control_files._set_transaction(transaction)
755
def abspath(self, name):
756
"""See Branch.abspath."""
757
return self.control_files._transport.abspath(name)
759
def _check_format(self, format):
760
"""Identify the branch format if needed.
762
The format is stored as a reference to the format object in
763
self._format for code that needs to check it later.
765
The format parameter is either None or the branch format class
766
used to open this branch.
768
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
771
format = BzrBranchFormat.find_format(self.bzrdir)
772
self._format = format
773
mutter("got branch format %s", self._format)
776
def get_root_id(self):
777
"""See Branch.get_root_id."""
778
tree = self.repository.revision_tree(self.last_revision())
779
return tree.inventory.root.file_id
781
def lock_write(self):
782
# TODO: test for failed two phase locks. This is known broken.
783
self.control_files.lock_write()
784
self.repository.lock_write()
787
# TODO: test for failed two phase locks. This is known broken.
788
self.control_files.lock_read()
789
self.repository.lock_read()
792
# TODO: test for failed two phase locks. This is known broken.
793
self.repository.unlock()
794
self.control_files.unlock()
796
def peek_lock_mode(self):
797
if self.control_files._lock_count == 0:
800
return self.control_files._lock_mode
803
def print_file(self, file, revision_id):
804
"""See Branch.print_file."""
805
return self.repository.print_file(file, revision_id)
808
def append_revision(self, *revision_ids):
809
"""See Branch.append_revision."""
810
for revision_id in revision_ids:
811
mutter("add {%s} to revision-history" % revision_id)
812
rev_history = self.revision_history()
813
rev_history.extend(revision_ids)
814
self.set_revision_history(rev_history)
817
def set_revision_history(self, rev_history):
818
"""See Branch.set_revision_history."""
819
self.control_files.put_utf8(
820
'revision-history', '\n'.join(rev_history))
822
def get_revision_delta(self, revno):
823
"""Return the delta for one revision.
825
The delta is relative to its mainline predecessor, or the
826
empty tree for revision 1.
828
assert isinstance(revno, int)
829
rh = self.revision_history()
830
if not (1 <= revno <= len(rh)):
831
raise InvalidRevisionNumber(revno)
833
# revno is 1-based; list is 0-based
835
new_tree = self.repository.revision_tree(rh[revno-1])
837
old_tree = EmptyTree()
839
old_tree = self.repository.revision_tree(rh[revno-2])
840
return compare_trees(old_tree, new_tree)
843
def revision_history(self):
844
"""See Branch.revision_history."""
845
# FIXME are transactions bound to control files ? RBC 20051121
846
transaction = self.get_transaction()
847
history = transaction.map.find_revision_history()
848
if history is not None:
849
mutter("cache hit for revision-history in %s", self)
851
history = [l.rstrip('\r\n') for l in
852
self.control_files.get_utf8('revision-history').readlines()]
853
transaction.map.add_revision_history(history)
854
# this call is disabled because revision_history is
855
# not really an object yet, and the transaction is for objects.
856
# transaction.register_clean(history, precious=True)
859
def update_revisions(self, other, stop_revision=None):
860
"""See Branch.update_revisions."""
861
from bzrlib.fetch import greedy_fetch
862
if stop_revision is None:
863
stop_revision = other.last_revision()
864
### Should this be checking is_ancestor instead of revision_history?
865
if (stop_revision is not None and
866
stop_revision in self.revision_history()):
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1256
f = AtomicFile(self.controlfilename('pending-merges'))
868
greedy_fetch(to_branch=self, from_branch=other,
869
revision=stop_revision)
870
pullable_revs = self.pullable_revisions(other, stop_revision)
871
if len(pullable_revs) > 0:
872
self.append_revision(*pullable_revs)
874
def pullable_revisions(self, other, stop_revision):
875
"""See Branch.pullable_revisions."""
876
other_revno = other.revision_id_to_revno(stop_revision)
878
return self.missing_revisions(other, other_revno)
879
except DivergedBranches, e:
881
pullable_revs = get_intervening_revisions(self.last_revision(),
884
assert self.last_revision() not in pullable_revs
886
except bzrlib.errors.NotAncestor:
887
if is_ancestor(self.last_revision(), stop_revision, self):
892
def basis_tree(self):
893
"""See Branch.basis_tree."""
894
return self.repository.revision_tree(self.last_revision())
896
@deprecated_method(zero_eight)
897
def working_tree(self):
898
"""Create a Working tree object for this branch."""
899
from bzrlib.workingtree import WorkingTree
900
from bzrlib.transport.local import LocalTransport
901
if (self.base.find('://') != -1 or
902
not isinstance(self._transport, LocalTransport)):
903
raise NoWorkingTree(self.base)
904
return WorkingTree(self.base, branch=self)
907
def pull(self, source, overwrite=False):
908
"""See Branch.pull."""
911
old_count = len(self.revision_history())
913
self.update_revisions(source)
914
except DivergedBranches:
918
self.set_revision_history(source.revision_history())
919
new_count = len(self.revision_history())
920
return new_count - old_count
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
924
def get_parent(self):
925
"""See Branch.get_parent."""
927
_locs = ['parent', 'pull', 'x-pull']
930
return self.control_files.get_utf8(l).read().strip('\n')
935
def get_push_location(self):
936
"""See Branch.get_push_location."""
937
config = bzrlib.config.BranchConfig(self)
938
push_loc = config.get_user_option('push_location')
941
def set_push_location(self, location):
942
"""See Branch.set_push_location."""
943
config = bzrlib.config.LocationConfig(self.base)
944
config.set_user_option('push_location', location)
947
def set_parent(self, url):
948
"""See Branch.set_parent."""
949
# TODO: Maybe delete old location files?
950
# URLs should never be unicode, even on the local fs,
951
# FIXUP this and get_parent in a future branch format bump:
952
# read and rewrite the file, and have the new format code read
953
# using .get not .get_utf8. RBC 20060125
954
self.control_files.put_utf8('parent', url + '\n')
956
def tree_config(self):
957
return TreeConfig(self)
959
def _get_truncated_history(self, revision_id):
960
history = self.revision_history()
961
if revision_id is None:
964
idx = history.index(revision_id)
966
raise InvalidRevisionId(revision_id=revision, branch=self)
967
return history[:idx+1]
970
def _clone_weave(self, to_location, revision=None, basis_branch=None):
972
from bzrlib.workingtree import WorkingTree
973
assert isinstance(to_location, basestring)
974
if basis_branch is not None:
975
note("basis_branch is not supported for fast weave copy yet.")
977
history = self._get_truncated_history(revision)
978
if not bzrlib.osutils.lexists(to_location):
979
os.mkdir(to_location)
980
bzrdir_to = self.bzrdir._format.initialize(to_location)
981
self.repository.clone(bzrdir_to)
982
branch_to = bzrdir_to.create_branch()
983
mutter("copy branch from %s to %s", self, branch_to)
985
# FIXME duplicate code with base .clone().
986
# .. would template method be useful here? RBC 20051207
987
branch_to.set_parent(self.base)
988
branch_to.append_revision(*history)
989
WorkingTree.create(branch_to, branch_to.base)
993
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
994
print "FIXME: clone via create and fetch is probably faster when versioned file comes in."
995
if (to_branch_type is None
996
and self.repository.weave_store.listable()
997
and self.repository.revision_store.listable()):
998
return self._clone_weave(to_location, revision, basis_branch)
1000
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
1003
class BranchTestProviderAdapter(object):
1004
"""A tool to generate a suite testing multiple branch formats at once.
1006
This is done by copying the test once for each transport and injecting
1007
the transport_server, transport_readonly_server, and branch_format
1008
classes into each copy. Each copy is also given a new id() to make it
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1282
This creates a temporary directory and runs init-tree in it.
1284
If any files are listed, they are created in the working copy.
1286
from tempfile import mkdtemp
1291
Branch.__init__(self, base, init=init)
1293
os.mkdir(self.abspath(d))
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1323
mutter("delete ScratchBranch %s" % self.base)
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1331
os.chmod(os.path.join(root, name), 0700)
1012
def __init__(self, transport_server, transport_readonly_server, formats):
1013
self._transport_server = transport_server
1014
self._transport_readonly_server = transport_readonly_server
1015
self._formats = formats
1017
def adapt(self, test):
1018
result = TestSuite()
1019
for branch_format, bzrdir_format in self._formats:
1020
new_test = deepcopy(test)
1021
new_test.transport_server = self._transport_server
1022
new_test.transport_readonly_server = self._transport_readonly_server
1023
new_test.bzrdir_format = bzrdir_format
1024
new_test.branch_format = branch_format
1025
def make_new_test_id():
1026
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1027
return lambda: new_id
1028
new_test.id = make_new_test_id()
1029
result.addTest(new_test)
1337
1033
######################################################################
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
1349
if filename == head:
1356
def gen_file_id(name):
1357
"""Return new file id.
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1363
from binascii import hexlify
1364
from time import time
1366
# get last component
1367
idx = name.rfind('/')
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1372
name = name[idx+1 : ]
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
1037
@deprecated_function(zero_eight)
1038
def ScratchBranch(*args, **kwargs):
1039
"""See bzrlib.bzrdir.ScratchDir."""
1040
d = ScratchDir(*args, **kwargs)
1041
return d.open_branch()
1044
@deprecated_function(zero_eight)
1045
def is_control_file(*args, **kwargs):
1046
"""See bzrlib.workingtree.is_control_file."""
1047
return bzrlib.workingtree.is_control_file(*args, **kwargs)