66
129
"""Branch holding a history of revisions.
69
Base directory/url of the branch.
132
Base directory of the branch.
138
If _lock_mode is true, a positive count of the number of times the
142
Lock object from bzrlib.lock.
71
# this is really an instance variable - FIXME move it there
75
def __init__(self, *ignored, **ignored_too):
76
raise NotImplementedError('The Branch class is abstract')
79
"""Break a lock if one is present from another instance.
81
Uses the ui factory to ask for confirmation if the lock may be from
84
This will probe the repository for its lock as well.
86
self.control_files.break_lock()
87
self.repository.break_lock()
88
master = self.get_master_branch()
89
if master is not None:
93
@deprecated_method(zero_eight)
94
def open_downlevel(base):
95
"""Open a branch which may be of an old format."""
96
return Branch.open(base, _unsupported=True)
99
def open(base, _unsupported=False):
100
"""Open the repository rooted at base.
102
For instance, if the repository is at URL/.bzr/repository,
103
Repository.open(URL) -> a Repository instance.
105
control = bzrdir.BzrDir.open(base, _unsupported)
106
return control.open_branch(_unsupported)
109
def open_containing(url):
110
"""Open an existing branch which contains url.
112
This probes for a branch at url, and searches upwards from there.
114
Basically we keep looking up until we find the control directory or
115
run into the root. If there isn't one, raises NotBranchError.
116
If there is one and it is either an unrecognised format or an unsupported
117
format, UnknownFormatError or UnsupportedFormatError are raised.
118
If there is one, it is returned, along with the unused portion of url.
120
control, relpath = bzrdir.BzrDir.open_containing(url)
121
return control.open_branch(), relpath
124
@deprecated_function(zero_eight)
125
def initialize(base):
126
"""Create a new working tree and branch, rooted at 'base' (url)
128
NOTE: This will soon be deprecated in favour of creation
131
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
133
def setup_caching(self, cache_root):
134
"""Subclasses that care about caching should override this, and set
135
up cached stores located under cache_root.
137
# seems to be unused, 2006-01-13 mbp
138
warn('%s is deprecated' % self.setup_caching)
139
self.cache_root = cache_root
141
def get_config(self):
142
return bzrlib.config.BranchConfig(self)
145
return self.get_config().get_nickname()
147
def _set_nick(self, nick):
148
self.get_config().set_user_option('nickname', nick)
150
nick = property(_get_nick, _set_nick)
153
raise NotImplementedError('is_locked is abstract')
150
# Map some sort of prefix into a namespace
151
# stuff like "revno:10", "revid:", etc.
152
# This should match a prefix with a function which accepts
153
REVISION_NAMESPACES = {}
155
def __init__(self, transport, init=False):
156
"""Create new branch object at a particular location.
158
transport -- A Transport object, defining how to access files.
159
(If a string, transport.transport() will be used to
160
create a Transport object)
162
init -- If True, create new control files in a previously
163
unversioned directory. If False, the branch must already
166
In the test suite, creation of new trees is tested using the
167
`ScratchBranch` class.
169
if isinstance(transport, basestring):
170
from transport import transport as get_transport
171
transport = get_transport(transport)
173
self._transport = transport
180
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
187
if self._lock_mode or self._lock:
188
from bzrlib.warnings import warn
189
warn("branch %r was not explicitly unlocked" % self)
192
# TODO: It might be best to do this somewhere else,
193
# but it is nice for a Branch object to automatically
194
# cache it's information.
195
# Alternatively, we could have the Transport objects cache requests
196
# See the earlier discussion about how major objects (like Branch)
197
# should never expect their __del__ function to run.
198
if self.cache_root is not None:
199
#from warnings import warn
200
#warn("branch %r auto-cleanup of cache files" % self)
203
shutil.rmtree(self.cache_root)
206
self.cache_root = None
210
return self._transport.base
213
base = property(_get_base)
155
216
def lock_write(self):
156
raise NotImplementedError('lock_write is abstract')
217
# TODO: Upgrade locking to support using a Transport,
218
# and potentially a remote locking protocol
220
if self._lock_mode != 'w':
221
from bzrlib.errors import LockError
222
raise LockError("can't upgrade to a write lock from %r" %
224
self._lock_count += 1
226
self._lock = self._transport.lock_write(
227
self._rel_controlfilename('branch-lock'))
228
self._lock_mode = 'w'
158
232
def lock_read(self):
159
raise NotImplementedError('lock_read is abstract')
234
assert self._lock_mode in ('r', 'w'), \
235
"invalid lock mode %r" % self._lock_mode
236
self._lock_count += 1
238
self._lock = self._transport.lock_read(
239
self._rel_controlfilename('branch-lock'))
240
self._lock_mode = 'r'
161
243
def unlock(self):
162
raise NotImplementedError('unlock is abstract')
164
def peek_lock_mode(self):
165
"""Return lock mode for the Branch: 'r', 'w' or None"""
166
raise NotImplementedError(self.peek_lock_mode)
168
def get_physical_lock_status(self):
169
raise NotImplementedError('get_physical_lock_status is abstract')
244
if not self._lock_mode:
245
from bzrlib.errors import LockError
246
raise LockError('branch %r is not locked' % (self))
248
if self._lock_count > 1:
249
self._lock_count -= 1
253
self._lock_mode = self._lock_count = None
171
255
def abspath(self, name):
172
"""Return absolute filename for something in the branch
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
177
raise NotImplementedError('abspath is abstract')
179
def bind(self, other):
180
"""Bind the local branch the other branch.
182
:param other: The branch to bind to
185
raise errors.UpgradeRequired(self.base)
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
194
:param pb: An optional progress bar to use.
196
Returns the copied revision count and the failed revisions in a tuple:
199
if self.base == from_branch.base:
202
nested_pb = ui.ui_factory.nested_progress_bar()
256
"""Return absolute filename for something in the branch"""
257
return self._transport.abspath(name)
259
def relpath(self, path):
260
"""Return path relative to this branch of something inside it.
262
Raises an error if path is not in this branch."""
263
return self._transport.relpath(path)
266
def _rel_controlfilename(self, file_or_path):
267
if isinstance(file_or_path, basestring):
268
file_or_path = [file_or_path]
269
return [bzrlib.BZRDIR] + file_or_path
271
def controlfilename(self, file_or_path):
272
"""Return location relative to branch."""
273
return self._transport.abspath(self._rel_controlfilename(file_or_path))
276
def controlfile(self, file_or_path, mode='r'):
277
"""Open a control file for this branch.
279
There are two classes of file in the control directory: text
280
and binary. binary files are untranslated byte streams. Text
281
control files are stored with Unix newlines and in UTF-8, even
282
if the platform or locale defaults are different.
284
Controlfiles should almost never be opened in write mode but
285
rather should be atomically copied and replaced using atomicfile.
289
relpath = self._rel_controlfilename(file_or_path)
290
#TODO: codecs.open() buffers linewise, so it was overloaded with
291
# a much larger buffer, do we need to do the same for getreader/getwriter?
293
return self._transport.get(relpath)
295
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
297
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
299
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
207
from_branch.lock_read()
209
if last_revision is None:
210
pb.update('get source history')
211
from_history = from_branch.revision_history()
213
last_revision = from_history[-1]
301
raise BzrError("invalid controlfile mode %r" % mode)
303
def put_controlfile(self, path, f, encode=True):
304
"""Write an entry as a controlfile.
306
:param path: The path to put the file, relative to the .bzr control
308
:param f: A file-like or string object whose contents should be copied.
309
:param encode: If true, encode the contents as utf-8
311
self.put_controlfiles([(path, f)], encode=encode)
313
def put_controlfiles(self, files, encode=True):
314
"""Write several entries as controlfiles.
316
:param files: A list of [(path, file)] pairs, where the path is the directory
317
underneath the bzr control directory
318
:param encode: If true, encode the contents as utf-8
322
for path, f in files:
324
if isinstance(f, basestring):
325
f = f.encode('utf-8', 'replace')
215
# no history in the source branch
216
last_revision = revision.NULL_REVISION
217
return self.repository.fetch(from_branch.repository,
218
revision_id=last_revision,
221
if nested_pb is not None:
225
def get_bound_location(self):
226
"""Return the URL of the branch we are bound to.
228
Older format branches cannot bind, please be sure to use a metadir
233
def get_commit_builder(self, parents, config=None, timestamp=None,
234
timezone=None, committer=None, revprops=None,
236
"""Obtain a CommitBuilder for this branch.
238
:param parents: Revision ids of the parents of the new revision.
239
:param config: Optional configuration to use.
240
:param timestamp: Optional timestamp recorded for commit.
241
:param timezone: Optional timezone for timestamp.
242
:param committer: Optional committer to set for commit.
243
:param revprops: Optional dictionary of revision properties.
244
:param revision_id: Optional revision id.
248
config = self.get_config()
250
return self.repository.get_commit_builder(self, parents, config,
251
timestamp, timezone, committer, revprops, revision_id)
253
def get_master_branch(self):
254
"""Return the branch we are bound to.
256
:return: Either a Branch, or None
327
f = codecs.getwriter('utf-8')(f, errors='replace')
328
path = self._rel_controlfilename(path)
329
ctrl_files.append((path, f))
330
self._transport.put_multi(ctrl_files)
332
def _make_control(self):
333
from bzrlib.inventory import Inventory
334
from cStringIO import StringIO
336
# Create an empty inventory
338
# if we want per-tree root ids then this is the place to set
339
# them; they're not needed for now and so ommitted for
341
bzrlib.xml.serializer_v4.write_inventory(Inventory(), sio)
343
dirs = [[], 'text-store', 'inventory-store', 'revision-store']
345
"This is a Bazaar-NG control directory.\n"
346
"Do not change any files in this directory.\n"),
347
('branch-format', BZR_BRANCH_FORMAT),
348
('revision-history', ''),
349
('merged-patches', ''),
350
('pending-merged-patches', ''),
353
('pending-merges', ''),
354
('inventory', sio.getvalue())
356
self._transport.mkdir_multi([self._rel_controlfilename(d) for d in dirs])
357
self.put_controlfiles(files)
358
mutter('created control directory in ' + self._transport.base)
360
def _check_format(self):
361
"""Check this branch format is supported.
363
The current tool only supports the current unstable format.
365
In the future, we might need different in-memory Branch
366
classes to support downlevel branches. But not yet.
368
# This ignores newlines so that we can open branches created
369
# on Windows from Linux and so on. I think it might be better
370
# to always make all internal files in unix format.
371
fmt = self.controlfile('branch-format', 'r').read()
372
fmt = fmt.replace('\r\n', '\n')
373
if fmt != BZR_BRANCH_FORMAT:
374
raise BzrError('sorry, branch format %r not supported' % fmt,
375
['use a different bzr version',
376
'or remove the .bzr directory and "bzr init" again'])
378
# We know that the format is the currently supported one.
379
# So create the rest of the entries.
380
from bzrlib.store.compressed_text import CompressedTextStore
382
if self._transport.should_cache():
384
self.cache_root = tempfile.mkdtemp(prefix='bzr-cache')
385
mutter('Branch %r using caching in %r' % (self, self.cache_root))
387
self.cache_root = None
390
relpath = self._rel_controlfilename(name)
391
store = CompressedTextStore(self._transport.clone(relpath))
392
if self._transport.should_cache():
393
from meta_store import CachedStore
394
cache_path = os.path.join(self.cache_root, name)
396
store = CachedStore(store, cache_path)
399
self.text_store = get_store('text-store')
400
self.revision_store = get_store('revision-store')
401
self.inventory_store = get_store('inventory-store')
403
def get_root_id(self):
404
"""Return the id of this branches root"""
405
inv = self.read_working_inventory()
406
return inv.root.file_id
408
def set_root_id(self, file_id):
409
inv = self.read_working_inventory()
410
orig_root_id = inv.root.file_id
411
del inv._byid[inv.root.file_id]
412
inv.root.file_id = file_id
413
inv._byid[inv.root.file_id] = inv.root
416
if entry.parent_id in (None, orig_root_id):
417
entry.parent_id = inv.root.file_id
418
self._write_inventory(inv)
420
def read_working_inventory(self):
421
"""Read the working inventory."""
422
from bzrlib.inventory import Inventory
425
# ElementTree does its own conversion from UTF-8, so open in
427
f = self.controlfile('inventory', 'rb')
428
return bzrlib.xml.serializer_v4.read_inventory(f)
433
def _write_inventory(self, inv):
434
"""Update the working inventory.
436
That is to say, the inventory describing changes underway, that
437
will be committed to the next revision.
439
from cStringIO import StringIO
443
bzrlib.xml.serializer_v4.write_inventory(inv, sio)
445
# Transport handles atomicity
446
self.put_controlfile('inventory', sio)
450
mutter('wrote working inventory')
453
inventory = property(read_working_inventory, _write_inventory, None,
454
"""Inventory for the working copy.""")
457
def add(self, files, ids=None):
458
"""Make files versioned.
460
Note that the command line normally calls smart_add instead,
461
which can automatically recurse.
463
This puts the files in the Added state, so that they will be
464
recorded by the next commit.
467
List of paths to add, relative to the base of the tree.
470
If set, use these instead of automatically generated ids.
471
Must be the same length as the list of files, but may
472
contain None for ids that are to be autogenerated.
474
TODO: Perhaps have an option to add the ids even if the files do
477
TODO: Perhaps yield the ids and paths as they're added.
479
# TODO: Re-adding a file that is removed in the working copy
480
# should probably put it back with the previous ID.
481
if isinstance(files, basestring):
482
assert(ids is None or isinstance(ids, basestring))
488
ids = [None] * len(files)
490
assert(len(ids) == len(files))
494
inv = self.read_working_inventory()
495
for f,file_id in zip(files, ids):
496
if is_control_file(f):
497
raise BzrError("cannot add control file %s" % quotefn(f))
502
raise BzrError("cannot add top-level %r" % f)
504
fullpath = os.path.normpath(self.abspath(f))
507
kind = file_kind(fullpath)
509
# maybe something better?
510
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
512
if kind != 'file' and kind != 'directory':
513
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
516
file_id = gen_file_id(f)
517
inv.add_path(f, kind=kind, file_id=file_id)
519
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
521
self._write_inventory(inv)
526
def print_file(self, file, revno):
527
"""Print `file` to stdout."""
530
tree = self.revision_tree(self.lookup_revision(revno))
531
# use inventory as it was in that revision
532
file_id = tree.inventory.path2id(file)
534
raise BzrError("%r is not present in revision %s" % (file, revno))
535
tree.print_file(file_id)
540
def remove(self, files, verbose=False):
541
"""Mark nominated files for removal from the inventory.
543
This does not remove their text. This does not run on
545
TODO: Refuse to remove modified files unless --force is given?
547
TODO: Do something useful with directories.
549
TODO: Should this remove the text or not? Tough call; not
550
removing may be useful and the user can just use use rm, and
551
is the opposite of add. Removing it is consistent with most
552
other tools. Maybe an option.
554
## TODO: Normalize names
555
## TODO: Remove nested loops; better scalability
556
if isinstance(files, basestring):
562
tree = self.working_tree()
565
# do this before any modifications
569
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
570
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
572
# having remove it, it must be either ignored or unknown
573
if tree.is_ignored(f):
577
show_status(new_status, inv[fid].kind, quotefn(f))
580
self._write_inventory(inv)
585
# FIXME: this doesn't need to be a branch method
586
def set_inventory(self, new_inventory_list):
587
from bzrlib.inventory import Inventory, InventoryEntry
588
inv = Inventory(self.get_root_id())
589
for path, file_id, parent, kind in new_inventory_list:
590
name = os.path.basename(path)
593
inv.add(InventoryEntry(file_id, name, kind, parent))
594
self._write_inventory(inv)
598
"""Return all unknown files.
600
These are files in the working directory that are not versioned or
601
control files or ignored.
603
>>> b = ScratchBranch(files=['foo', 'foo~'])
604
>>> list(b.unknowns())
607
>>> list(b.unknowns())
610
>>> list(b.unknowns())
613
return self.working_tree().unknowns()
616
def append_revision(self, *revision_ids):
617
for revision_id in revision_ids:
618
mutter("add {%s} to revision-history" % revision_id)
620
rev_history = self.revision_history()
621
rev_history.extend(revision_ids)
625
self.put_controlfile('revision-history', '\n'.join(rev_history))
630
def get_revision_xml_file(self, revision_id):
631
"""Return XML file object for revision object."""
632
if not revision_id or not isinstance(revision_id, basestring):
633
raise InvalidRevisionId(revision_id)
638
return self.revision_store[revision_id]
639
except (IndexError, KeyError):
640
raise bzrlib.errors.NoSuchRevision(self, revision_id)
646
get_revision_xml = get_revision_xml_file
649
def get_revision(self, revision_id):
650
"""Return the Revision object for a named revision"""
651
xml_file = self.get_revision_xml_file(revision_id)
654
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
655
except SyntaxError, e:
656
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
660
assert r.revision_id == revision_id
260
664
def get_revision_delta(self, revno):
261
665
"""Return the delta for one revision.
359
1032
raise bzrlib.errors.NoSuchRevision(self, revno)
360
1033
return history[revno - 1]
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
1035
def _get_revision_info(self, revision):
1036
"""Return (revno, revision id) for revision specifier.
1038
revision can be an integer, in which case it is assumed to be revno
1039
(though this will translate negative values into positive ones)
1040
revision can also be a string, in which case it is parsed for something
1041
like 'date:' or 'revid:' etc.
1043
A revid is always returned. If it is None, the specifier referred to
1044
the null revision. If the revid does not occur in the revision
1045
history, revno will be None.
1048
if revision is None:
1051
try:# Convert to int if possible
1052
revision = int(revision)
1055
revs = self.revision_history()
1056
if isinstance(revision, int):
1058
revno = len(revs) + revision + 1
1061
rev_id = self.get_rev_id(revno, revs)
1062
elif isinstance(revision, basestring):
1063
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
1064
if revision.startswith(prefix):
1065
result = func(self, revs, revision)
1067
revno, rev_id = result
1070
rev_id = self.get_rev_id(revno, revs)
1073
raise BzrError('No namespace registered for string: %r' %
1076
raise TypeError('Unhandled revision type %s' % revision)
1080
raise bzrlib.errors.NoSuchRevision(self, revision)
1081
return revno, rev_id
1083
def _namespace_revno(self, revs, revision):
1084
"""Lookup a revision by revision number"""
1085
assert revision.startswith('revno:')
1087
return (int(revision[6:]),)
1090
REVISION_NAMESPACES['revno:'] = _namespace_revno
1092
def _namespace_revid(self, revs, revision):
1093
assert revision.startswith('revid:')
1094
rev_id = revision[len('revid:'):]
1096
return revs.index(rev_id) + 1, rev_id
1099
REVISION_NAMESPACES['revid:'] = _namespace_revid
1101
def _namespace_last(self, revs, revision):
1102
assert revision.startswith('last:')
1104
offset = int(revision[5:])
1109
raise BzrError('You must supply a positive value for --revision last:XXX')
1110
return (len(revs) - offset + 1,)
1111
REVISION_NAMESPACES['last:'] = _namespace_last
1113
def _namespace_tag(self, revs, revision):
1114
assert revision.startswith('tag:')
1115
raise BzrError('tag: namespace registered, but not implemented.')
1116
REVISION_NAMESPACES['tag:'] = _namespace_tag
1118
def _namespace_date(self, revs, revision):
1119
assert revision.startswith('date:')
1121
# Spec for date revisions:
1123
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1124
# it can also start with a '+/-/='. '+' says match the first
1125
# entry after the given date. '-' is match the first entry before the date
1126
# '=' is match the first entry after, but still on the given date.
1128
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1129
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1130
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1131
# May 13th, 2005 at 0:00
1133
# So the proper way of saying 'give me all entries for today' is:
1134
# -r {date:+today}:{date:-tomorrow}
1135
# The default is '=' when not supplied
1138
if val[:1] in ('+', '-', '='):
1139
match_style = val[:1]
1142
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1143
if val.lower() == 'yesterday':
1144
dt = today - datetime.timedelta(days=1)
1145
elif val.lower() == 'today':
1147
elif val.lower() == 'tomorrow':
1148
dt = today + datetime.timedelta(days=1)
1151
# This should be done outside the function to avoid recompiling it.
1152
_date_re = re.compile(
1153
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1155
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1157
m = _date_re.match(val)
1158
if not m or (not m.group('date') and not m.group('time')):
1159
raise BzrError('Invalid revision date %r' % revision)
1162
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1164
year, month, day = today.year, today.month, today.day
1166
hour = int(m.group('hour'))
1167
minute = int(m.group('minute'))
1168
if m.group('second'):
1169
second = int(m.group('second'))
1173
hour, minute, second = 0,0,0
1175
dt = datetime.datetime(year=year, month=month, day=day,
1176
hour=hour, minute=minute, second=second)
1180
if match_style == '-':
1182
elif match_style == '=':
1183
last = dt + datetime.timedelta(days=1)
1186
for i in range(len(revs)-1, -1, -1):
1187
r = self.get_revision(revs[i])
1188
# TODO: Handle timezone.
1189
dt = datetime.datetime.fromtimestamp(r.timestamp)
1190
if first >= dt and (last is None or dt >= last):
1193
for i in range(len(revs)):
1194
r = self.get_revision(revs[i])
1195
# TODO: Handle timezone.
1196
dt = datetime.datetime.fromtimestamp(r.timestamp)
1197
if first <= dt and (last is None or dt <= last):
1199
REVISION_NAMESPACES['date:'] = _namespace_date
1202
def _namespace_ancestor(self, revs, revision):
1203
from revision import common_ancestor, MultipleRevisionSources
1204
other_branch = find_branch(_trim_namespace('ancestor', revision))
1205
revision_a = self.last_patch()
1206
revision_b = other_branch.last_patch()
1207
for r, b in ((revision_a, self), (revision_b, other_branch)):
1209
raise bzrlib.errors.NoCommits(b)
1210
revision_source = MultipleRevisionSources(self, other_branch)
1211
result = common_ancestor(revision_a, revision_b, revision_source)
1213
revno = self.revision_id_to_revno(result)
1214
except bzrlib.errors.NoSuchRevision:
1219
REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
1221
def revision_tree(self, revision_id):
1222
"""Return Tree for a revision on this branch.
1224
`revision_id` may be None for the null revision, in which case
1225
an `EmptyTree` is returned."""
1226
# TODO: refactor this to use an existing revision object
1227
# so we don't need to read it in twice.
1228
if revision_id == None:
1231
inv = self.get_revision_inventory(revision_id)
1232
return RevisionTree(self.text_store, inv)
1235
def working_tree(self):
1236
"""Return a `Tree` for the working copy."""
1237
from bzrlib.workingtree import WorkingTree
1238
# TODO: In the future, WorkingTree should utilize Transport
1239
return WorkingTree(self._transport.base, self.read_working_inventory())
365
1242
def basis_tree(self):
366
1243
"""Return `Tree` object for last revision.
368
1245
If there are no revisions yet, return an `EmptyTree`.
370
return self.repository.revision_tree(self.last_revision())
1247
r = self.last_patch()
1251
return RevisionTree(self.text_store, self.get_revision_inventory(r))
372
1255
def rename_one(self, from_rel, to_rel):
373
1256
"""Rename one file.
375
1258
This can change the directory or the filename or both.
377
raise NotImplementedError('rename_one is abstract')
1262
tree = self.working_tree()
1263
inv = tree.inventory
1264
if not tree.has_filename(from_rel):
1265
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1266
if tree.has_filename(to_rel):
1267
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1269
file_id = inv.path2id(from_rel)
1271
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1273
if inv.path2id(to_rel):
1274
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1276
to_dir, to_tail = os.path.split(to_rel)
1277
to_dir_id = inv.path2id(to_dir)
1278
if to_dir_id == None and to_dir != '':
1279
raise BzrError("can't determine destination directory id for %r" % to_dir)
1281
mutter("rename_one:")
1282
mutter(" file_id {%s}" % file_id)
1283
mutter(" from_rel %r" % from_rel)
1284
mutter(" to_rel %r" % to_rel)
1285
mutter(" to_dir %r" % to_dir)
1286
mutter(" to_dir_id {%s}" % to_dir_id)
1288
inv.rename(file_id, to_dir_id, to_tail)
1290
from_abs = self.abspath(from_rel)
1291
to_abs = self.abspath(to_rel)
1293
os.rename(from_abs, to_abs)
1295
raise BzrError("failed to rename %r to %r: %s"
1296
% (from_abs, to_abs, e[1]),
1297
["rename rolled back"])
1299
self._write_inventory(inv)
379
1304
def move(self, from_paths, to_name):
380
1305
"""Rename files.
454
1502
if revno < 1 or revno > self.revno():
455
1503
raise InvalidRevisionNumber(revno)
458
def clone(self, *args, **kwargs):
459
"""Clone this branch into to_bzrdir preserving all semantic values.
461
revision_id: if not None, the revision history in the new branch will
462
be truncated to end with revision_id.
464
# for API compatibility, until 0.8 releases we provide the old api:
465
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
466
# after 0.8 releases, the *args and **kwargs should be changed:
467
# def clone(self, to_bzrdir, revision_id=None):
468
if (kwargs.get('to_location', None) or
469
kwargs.get('revision', None) or
470
kwargs.get('basis_branch', None) or
471
(len(args) and isinstance(args[0], basestring))):
472
# backwards compatibility api:
473
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
474
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
477
basis_branch = args[2]
479
basis_branch = kwargs.get('basis_branch', None)
481
basis = basis_branch.bzrdir
486
revision_id = args[1]
488
revision_id = kwargs.get('revision', None)
493
# no default to raise if not provided.
494
url = kwargs.get('to_location')
495
return self.bzrdir.clone(url,
496
revision_id=revision_id,
497
basis=basis).open_branch()
499
# generate args by hand
501
revision_id = args[1]
503
revision_id = kwargs.get('revision_id', None)
507
# no default to raise if not provided.
508
to_bzrdir = kwargs.get('to_bzrdir')
509
result = self._format.initialize(to_bzrdir)
510
self.copy_content_into(result, revision_id=revision_id)
514
def sprout(self, to_bzrdir, revision_id=None):
515
"""Create a new line of development from the branch, into to_bzrdir.
517
revision_id: if not None, the revision history in the new branch will
518
be truncated to end with revision_id.
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id=revision_id)
522
result.set_parent(self.bzrdir.root_transport.base)
526
def copy_content_into(self, destination, revision_id=None):
527
"""Copy the content of self into destination.
529
revision_id: if not None, the revision history in the new branch will
530
be truncated to end with revision_id.
532
new_history = self.revision_history()
533
if revision_id is not None:
535
new_history = new_history[:new_history.index(revision_id) + 1]
537
rev = self.repository.get_revision(revision_id)
538
new_history = rev.get_history(self.repository)[1:]
539
destination.set_revision_history(new_history)
540
parent = self.get_parent()
542
destination.set_parent(parent)
546
"""Check consistency of the branch.
548
In particular this checks that revisions given in the revision-history
549
do actually match up in the revision graph, and that they're all
550
present in the repository.
552
Callers will typically also want to check the repository.
554
:return: A BranchCheckResult.
556
mainline_parent_id = None
557
for revision_id in self.revision_history():
559
revision = self.repository.get_revision(revision_id)
560
except errors.NoSuchRevision, e:
561
raise errors.BzrCheckError("mainline revision {%s} not in repository"
563
# In general the first entry on the revision history has no parents.
564
# But it's not illegal for it to have parents listed; this can happen
565
# in imports from Arch when the parents weren't reachable.
566
if mainline_parent_id is not None:
567
if mainline_parent_id not in revision.parent_ids:
568
raise errors.BzrCheckError("previous revision {%s} not listed among "
570
% (mainline_parent_id, revision_id))
571
mainline_parent_id = revision_id
572
return BranchCheckResult(self)
575
class BranchFormat(object):
576
"""An encapsulation of the initialization and open routines for a format.
578
Formats provide three things:
579
* An initialization routine,
583
Formats are placed in an dict by their format string for reference
584
during branch opening. Its not required that these be instances, they
585
can be classes themselves with class methods - it simply depends on
586
whether state is needed for a given format or not.
588
Once a format is deprecated, just deprecate the initialize and open
589
methods on the format class. Do not deprecate the object, as the
590
object will be created every time regardless.
593
_default_format = None
594
"""The default format used for new branches."""
597
"""The known formats."""
600
def find_format(klass, a_bzrdir):
601
"""Return the format for the branch object in a_bzrdir."""
603
transport = a_bzrdir.get_branch_transport(None)
604
format_string = transport.get("format").read()
605
return klass._formats[format_string]
607
raise NotBranchError(path=transport.base)
609
raise errors.UnknownFormatError(format=format_string)
612
def get_default_format(klass):
613
"""Return the current default format."""
614
return klass._default_format
616
def get_format_string(self):
617
"""Return the ASCII format string that identifies this format."""
618
raise NotImplementedError(self.get_format_string)
620
def get_format_description(self):
621
"""Return the short format description for this format."""
622
raise NotImplementedError(self.get_format_string)
624
def initialize(self, a_bzrdir):
625
"""Create a branch of this format in a_bzrdir."""
626
raise NotImplementedError(self.initialize)
628
def is_supported(self):
629
"""Is this format supported?
631
Supported formats can be initialized and opened.
632
Unsupported formats may not support initialization or committing or
633
some other features depending on the reason for not being supported.
637
def open(self, a_bzrdir, _found=False):
638
"""Return the branch object for a_bzrdir
640
_found is a private parameter, do not use it. It is used to indicate
641
if format probing has already be done.
643
raise NotImplementedError(self.open)
646
def register_format(klass, format):
647
klass._formats[format.get_format_string()] = format
650
def set_default_format(klass, format):
651
klass._default_format = format
654
def unregister_format(klass, format):
655
assert klass._formats[format.get_format_string()] is format
656
del klass._formats[format.get_format_string()]
659
return self.get_format_string().rstrip()
662
class BzrBranchFormat4(BranchFormat):
663
"""Bzr branch format 4.
666
- a revision-history file.
667
- a branch-lock lock file [ to be shared with the bzrdir ]
670
def get_format_description(self):
671
"""See BranchFormat.get_format_description()."""
672
return "Branch format 4"
674
def initialize(self, a_bzrdir):
675
"""Create a branch of this format in a_bzrdir."""
676
mutter('creating branch in %s', a_bzrdir.transport.base)
677
branch_transport = a_bzrdir.get_branch_transport(self)
678
utf8_files = [('revision-history', ''),
681
control_files = LockableFiles(branch_transport, 'branch-lock',
683
control_files.create_lock()
684
control_files.lock_write()
686
for file, content in utf8_files:
687
control_files.put_utf8(file, content)
689
control_files.unlock()
690
return self.open(a_bzrdir, _found=True)
693
super(BzrBranchFormat4, self).__init__()
694
self._matchingbzrdir = bzrdir.BzrDirFormat6()
696
def open(self, a_bzrdir, _found=False):
697
"""Return the branch object for a_bzrdir
699
_found is a private parameter, do not use it. It is used to indicate
700
if format probing has already be done.
703
# we are being called directly and must probe.
704
raise NotImplementedError
705
return BzrBranch(_format=self,
706
_control_files=a_bzrdir._control_files,
708
_repository=a_bzrdir.open_repository())
711
return "Bazaar-NG branch format 4"
714
class BzrBranchFormat5(BranchFormat):
715
"""Bzr branch format 5.
718
- a revision-history file.
720
- a lock dir guarding the branch itself
721
- all of this stored in a branch/ subdirectory
722
- works with shared repositories.
724
This format is new in bzr 0.8.
727
def get_format_string(self):
728
"""See BranchFormat.get_format_string()."""
729
return "Bazaar-NG branch format 5\n"
731
def get_format_description(self):
732
"""See BranchFormat.get_format_description()."""
733
return "Branch format 5"
735
def initialize(self, a_bzrdir):
736
"""Create a branch of this format in a_bzrdir."""
737
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
738
branch_transport = a_bzrdir.get_branch_transport(self)
739
utf8_files = [('revision-history', ''),
742
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
743
control_files.create_lock()
744
control_files.lock_write()
745
control_files.put_utf8('format', self.get_format_string())
747
for file, content in utf8_files:
748
control_files.put_utf8(file, content)
750
control_files.unlock()
751
return self.open(a_bzrdir, _found=True, )
754
super(BzrBranchFormat5, self).__init__()
755
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
757
def open(self, a_bzrdir, _found=False):
758
"""Return the branch object for a_bzrdir
760
_found is a private parameter, do not use it. It is used to indicate
761
if format probing has already be done.
764
format = BranchFormat.find_format(a_bzrdir)
765
assert format.__class__ == self.__class__
766
transport = a_bzrdir.get_branch_transport(None)
767
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
768
return BzrBranch5(_format=self,
769
_control_files=control_files,
771
_repository=a_bzrdir.find_repository())
774
return "Bazaar-NG Metadir branch format 5"
777
class BranchReferenceFormat(BranchFormat):
778
"""Bzr branch reference format.
780
Branch references are used in implementing checkouts, they
781
act as an alias to the real branch which is at some other url.
788
def get_format_string(self):
789
"""See BranchFormat.get_format_string()."""
790
return "Bazaar-NG Branch Reference Format 1\n"
792
def get_format_description(self):
793
"""See BranchFormat.get_format_description()."""
794
return "Checkout reference format 1"
796
def initialize(self, a_bzrdir, target_branch=None):
797
"""Create a branch of this format in a_bzrdir."""
798
if target_branch is None:
799
# this format does not implement branch itself, thus the implicit
800
# creation contract must see it as uninitializable
801
raise errors.UninitializableFormat(self)
802
mutter('creating branch reference in %s', a_bzrdir.transport.base)
803
branch_transport = a_bzrdir.get_branch_transport(self)
804
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
805
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
806
branch_transport.put('format', StringIO(self.get_format_string()))
807
return self.open(a_bzrdir, _found=True)
810
super(BranchReferenceFormat, self).__init__()
811
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
813
def _make_reference_clone_function(format, a_branch):
814
"""Create a clone() routine for a branch dynamically."""
815
def clone(to_bzrdir, revision_id=None):
816
"""See Branch.clone()."""
817
return format.initialize(to_bzrdir, a_branch)
818
# cannot obey revision_id limits when cloning a reference ...
819
# FIXME RBC 20060210 either nuke revision_id for clone, or
820
# emit some sort of warning/error to the caller ?!
823
def open(self, a_bzrdir, _found=False):
824
"""Return the branch that the branch reference in a_bzrdir points at.
826
_found is a private parameter, do not use it. It is used to indicate
827
if format probing has already be done.
830
format = BranchFormat.find_format(a_bzrdir)
831
assert format.__class__ == self.__class__
832
transport = a_bzrdir.get_branch_transport(None)
833
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
834
result = real_bzrdir.open_branch()
835
# this changes the behaviour of result.clone to create a new reference
836
# rather than a copy of the content of the branch.
837
# I did not use a proxy object because that needs much more extensive
838
# testing, and we are only changing one behaviour at the moment.
839
# If we decide to alter more behaviours - i.e. the implicit nickname
840
# then this should be refactored to introduce a tested proxy branch
841
# and a subclass of that for use in overriding clone() and ....
843
result.clone = self._make_reference_clone_function(result)
847
# formats which have no format string are not discoverable
848
# and not independently creatable, so are not registered.
849
__default_format = BzrBranchFormat5()
850
BranchFormat.register_format(__default_format)
851
BranchFormat.register_format(BranchReferenceFormat())
852
BranchFormat.set_default_format(__default_format)
853
_legacy_formats = [BzrBranchFormat4(),
856
class BzrBranch(Branch):
857
"""A branch stored in the actual filesystem.
859
Note that it's "local" in the context of the filesystem; it doesn't
860
really matter if it's on an nfs/smb/afs/coda/... share, as long as
861
it's writable, and can be accessed via the normal filesystem API.
1508
class ScratchBranch(Branch):
1509
"""Special test class: a branch that cleans up after itself.
1511
>>> b = ScratchBranch()
1519
def __init__(self, files=[], dirs=[], base=None):
1520
"""Make a test branch.
1522
This creates a temporary directory and runs init-tree in it.
1524
If any files are listed, they are created in the working copy.
1526
from tempfile import mkdtemp
1531
Branch.__init__(self, base, init=init)
1533
self._transport.mkdir(d)
1536
self._transport.put(f, 'content of %s' % f)
1541
>>> orig = ScratchBranch(files=["file1", "file2"])
1542
>>> clone = orig.clone()
1543
>>> os.path.samefile(orig.base, clone.base)
1545
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1548
from shutil import copytree
1549
from tempfile import mkdtemp
1552
copytree(self.base, base, symlinks=True)
1553
return ScratchBranch(base=base)
1561
"""Destroy the test branch, removing the scratch directory."""
1562
from shutil import rmtree
1565
mutter("delete ScratchBranch %s" % self.base)
1568
# Work around for shutil.rmtree failing on Windows when
1569
# readonly files are encountered
1570
mutter("hit exception in destroying ScratchBranch: %s" % e)
1571
for root, dirs, files in os.walk(self.base, topdown=False):
1573
os.chmod(os.path.join(root, name), 0700)
1575
self._transport = None
864
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
865
relax_version_check=DEPRECATED_PARAMETER, _format=None,
866
_control_files=None, a_bzrdir=None, _repository=None):
867
"""Create new branch object at a particular location.
869
transport -- A Transport object, defining how to access files.
871
init -- If True, create new control files in a previously
872
unversioned directory. If False, the branch must already
875
relax_version_check -- If true, the usual check for the branch
876
version is not applied. This is intended only for
877
upgrade/recovery type use; it's not guaranteed that
878
all operations will work on old format branches.
881
self.bzrdir = bzrdir.BzrDir.open(transport.base)
883
self.bzrdir = a_bzrdir
884
self._transport = self.bzrdir.transport.clone('..')
885
self._base = self._transport.base
886
self._format = _format
887
if _control_files is None:
888
raise ValueError('BzrBranch _control_files is None')
889
self.control_files = _control_files
890
if deprecated_passed(init):
891
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
892
"deprecated as of bzr 0.8. Please use Branch.create().",
896
# this is slower than before deprecation, oh well never mind.
898
self._initialize(transport.base)
899
self._check_format(_format)
900
if deprecated_passed(relax_version_check):
901
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
902
"relax_version_check parameter is deprecated as of bzr 0.8. "
903
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
907
if (not relax_version_check
908
and not self._format.is_supported()):
909
raise errors.UnsupportedFormatError(format=fmt)
910
if deprecated_passed(transport):
911
warn("BzrBranch.__init__(transport=XXX...): The transport "
912
"parameter is deprecated as of bzr 0.8. "
913
"Please use Branch.open, or bzrdir.open_branch().",
916
self.repository = _repository
919
return '%s(%r)' % (self.__class__.__name__, self.base)
924
# TODO: It might be best to do this somewhere else,
925
# but it is nice for a Branch object to automatically
926
# cache it's information.
927
# Alternatively, we could have the Transport objects cache requests
928
# See the earlier discussion about how major objects (like Branch)
929
# should never expect their __del__ function to run.
930
# XXX: cache_root seems to be unused, 2006-01-13 mbp
931
if hasattr(self, 'cache_root') and self.cache_root is not None:
933
osutils.rmtree(self.cache_root)
936
self.cache_root = None
941
base = property(_get_base, doc="The URL for the root of this branch.")
943
def _finish_transaction(self):
944
"""Exit the current transaction."""
945
return self.control_files._finish_transaction()
947
def get_transaction(self):
948
"""Return the current active transaction.
950
If no transaction is active, this returns a passthrough object
951
for which all data is immediately flushed and no caching happens.
953
# this is an explicit function so that we can do tricky stuff
954
# when the storage in rev_storage is elsewhere.
955
# we probably need to hook the two 'lock a location' and
956
# 'have a transaction' together more delicately, so that
957
# we can have two locks (branch and storage) and one transaction
958
# ... and finishing the transaction unlocks both, but unlocking
959
# does not. - RBC 20051121
960
return self.control_files.get_transaction()
962
def _set_transaction(self, transaction):
963
"""Set a new active transaction."""
964
return self.control_files._set_transaction(transaction)
966
def abspath(self, name):
967
"""See Branch.abspath."""
968
return self.control_files._transport.abspath(name)
970
def _check_format(self, format):
971
"""Identify the branch format if needed.
973
The format is stored as a reference to the format object in
974
self._format for code that needs to check it later.
976
The format parameter is either None or the branch format class
977
used to open this branch.
979
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
982
format = BranchFormat.find_format(self.bzrdir)
983
self._format = format
984
mutter("got branch format %s", self._format)
987
def get_root_id(self):
988
"""See Branch.get_root_id."""
989
tree = self.repository.revision_tree(self.last_revision())
990
return tree.inventory.root.file_id
993
return self.control_files.is_locked()
995
def lock_write(self):
996
# TODO: test for failed two phase locks. This is known broken.
997
self.control_files.lock_write()
998
self.repository.lock_write()
1000
def lock_read(self):
1001
# TODO: test for failed two phase locks. This is known broken.
1002
self.control_files.lock_read()
1003
self.repository.lock_read()
1006
# TODO: test for failed two phase locks. This is known broken.
1008
self.repository.unlock()
1010
self.control_files.unlock()
1012
def peek_lock_mode(self):
1013
if self.control_files._lock_count == 0:
1016
return self.control_files._lock_mode
1018
def get_physical_lock_status(self):
1019
return self.control_files.get_physical_lock_status()
1022
def print_file(self, file, revision_id):
1023
"""See Branch.print_file."""
1024
return self.repository.print_file(file, revision_id)
1027
def append_revision(self, *revision_ids):
1028
"""See Branch.append_revision."""
1029
for revision_id in revision_ids:
1030
mutter("add {%s} to revision-history" % revision_id)
1031
rev_history = self.revision_history()
1032
rev_history.extend(revision_ids)
1033
self.set_revision_history(rev_history)
1036
def set_revision_history(self, rev_history):
1037
"""See Branch.set_revision_history."""
1038
self.control_files.put_utf8(
1039
'revision-history', '\n'.join(rev_history))
1040
transaction = self.get_transaction()
1041
history = transaction.map.find_revision_history()
1042
if history is not None:
1043
# update the revision history in the identity map.
1044
history[:] = list(rev_history)
1045
# this call is disabled because revision_history is
1046
# not really an object yet, and the transaction is for objects.
1047
# transaction.register_dirty(history)
1049
transaction.map.add_revision_history(rev_history)
1050
# this call is disabled because revision_history is
1051
# not really an object yet, and the transaction is for objects.
1052
# transaction.register_clean(history)
1055
def revision_history(self):
1056
"""See Branch.revision_history."""
1057
transaction = self.get_transaction()
1058
history = transaction.map.find_revision_history()
1059
if history is not None:
1060
mutter("cache hit for revision-history in %s", self)
1061
return list(history)
1062
history = [l.rstrip('\r\n') for l in
1063
self.control_files.get_utf8('revision-history').readlines()]
1064
transaction.map.add_revision_history(history)
1065
# this call is disabled because revision_history is
1066
# not really an object yet, and the transaction is for objects.
1067
# transaction.register_clean(history, precious=True)
1068
return list(history)
1071
def generate_revision_history(self, revision_id, last_rev=None,
1073
"""Create a new revision history that will finish with revision_id.
1075
:param revision_id: the new tip to use.
1076
:param last_rev: The previous last_revision. If not None, then this
1077
must be a ancestory of revision_id, or DivergedBranches is raised.
1078
:param other_branch: The other branch that DivergedBranches should
1079
raise with respect to.
1081
# stop_revision must be a descendant of last_revision
1082
stop_graph = self.repository.get_revision_graph(revision_id)
1083
if last_rev is not None and last_rev not in stop_graph:
1084
# our previous tip is not merged into stop_revision
1085
raise errors.DivergedBranches(self, other_branch)
1086
# make a new revision history from the graph
1087
current_rev_id = revision_id
1089
while current_rev_id not in (None, revision.NULL_REVISION):
1090
new_history.append(current_rev_id)
1091
current_rev_id_parents = stop_graph[current_rev_id]
1093
current_rev_id = current_rev_id_parents[0]
1095
current_rev_id = None
1096
new_history.reverse()
1097
self.set_revision_history(new_history)
1100
def update_revisions(self, other, stop_revision=None):
1101
"""See Branch.update_revisions."""
1104
if stop_revision is None:
1105
stop_revision = other.last_revision()
1106
if stop_revision is None:
1107
# if there are no commits, we're done.
1109
# whats the current last revision, before we fetch [and change it
1111
last_rev = self.last_revision()
1112
# we fetch here regardless of whether we need to so that we pickup
1114
self.fetch(other, stop_revision)
1115
my_ancestry = self.repository.get_ancestry(last_rev)
1116
if stop_revision in my_ancestry:
1117
# last_revision is a descendant of stop_revision
1119
self.generate_revision_history(stop_revision, last_rev=last_rev,
1124
def basis_tree(self):
1125
"""See Branch.basis_tree."""
1126
return self.repository.revision_tree(self.last_revision())
1128
@deprecated_method(zero_eight)
1129
def working_tree(self):
1130
"""Create a Working tree object for this branch."""
1132
from bzrlib.transport.local import LocalTransport
1133
if (self.base.find('://') != -1 or
1134
not isinstance(self._transport, LocalTransport)):
1135
raise NoWorkingTree(self.base)
1136
return self.bzrdir.open_workingtree()
1139
def pull(self, source, overwrite=False, stop_revision=None):
1140
"""See Branch.pull."""
1143
old_count = len(self.revision_history())
1145
self.update_revisions(source,stop_revision)
1146
except DivergedBranches:
1150
self.set_revision_history(source.revision_history())
1151
new_count = len(self.revision_history())
1152
return new_count - old_count
1156
def get_parent(self):
1157
"""See Branch.get_parent."""
1159
_locs = ['parent', 'pull', 'x-pull']
1160
assert self.base[-1] == '/'
1163
parent = self.control_files.get(l).read().strip('\n')
1166
# This is an old-format absolute path to a local branch
1167
# turn it into a url
1168
if parent.startswith('/'):
1169
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1170
return urlutils.join(self.base[:-1], parent)
1173
def get_push_location(self):
1174
"""See Branch.get_push_location."""
1175
push_loc = self.get_config().get_user_option('push_location')
1178
def set_push_location(self, location):
1179
"""See Branch.set_push_location."""
1180
self.get_config().set_user_option('push_location', location,
1184
def set_parent(self, url):
1185
"""See Branch.set_parent."""
1186
# TODO: Maybe delete old location files?
1187
# URLs should never be unicode, even on the local fs,
1188
# FIXUP this and get_parent in a future branch format bump:
1189
# read and rewrite the file, and have the new format code read
1190
# using .get not .get_utf8. RBC 20060125
1192
self.control_files._transport.delete('parent')
1194
if isinstance(url, unicode):
1196
url = url.encode('ascii')
1197
except UnicodeEncodeError:
1198
raise bzrlib.errors.InvalidURL(url,
1199
"Urls must be 7-bit ascii, "
1200
"use bzrlib.urlutils.escape")
1202
url = urlutils.relative_url(self.base, url)
1203
self.control_files.put('parent', url + '\n')
1205
@deprecated_function(zero_nine)
1206
def tree_config(self):
1207
"""DEPRECATED; call get_config instead.
1208
TreeConfig has become part of BranchConfig."""
1209
return TreeConfig(self)
1212
class BzrBranch5(BzrBranch):
1213
"""A format 5 branch. This supports new features over plan branches.
1215
It has support for a master_branch which is the data for bound branches.
1223
super(BzrBranch5, self).__init__(_format=_format,
1224
_control_files=_control_files,
1226
_repository=_repository)
1229
def pull(self, source, overwrite=False, stop_revision=None):
1230
"""Updates branch.pull to be bound branch aware."""
1231
bound_location = self.get_bound_location()
1232
if source.base != bound_location:
1233
# not pulling from master, so we need to update master.
1234
master_branch = self.get_master_branch()
1236
master_branch.pull(source)
1237
source = master_branch
1238
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1240
def get_bound_location(self):
1242
return self.control_files.get_utf8('bound').read()[:-1]
1243
except errors.NoSuchFile:
1247
def get_master_branch(self):
1248
"""Return the branch we are bound to.
1250
:return: Either a Branch, or None
1252
This could memoise the branch, but if thats done
1253
it must be revalidated on each new lock.
1254
So for now we just don't memoise it.
1255
# RBC 20060304 review this decision.
1257
bound_loc = self.get_bound_location()
1261
return Branch.open(bound_loc)
1262
except (errors.NotBranchError, errors.ConnectionError), e:
1263
raise errors.BoundBranchConnectionFailure(
1267
def set_bound_location(self, location):
1268
"""Set the target where this branch is bound to.
1270
:param location: URL to the target branch
1273
self.control_files.put_utf8('bound', location+'\n')
1276
self.control_files._transport.delete('bound')
1579
######################################################################
1583
def is_control_file(filename):
1584
## FIXME: better check
1585
filename = os.path.normpath(filename)
1586
while filename != '':
1587
head, tail = os.path.split(filename)
1588
## mutter('check %r for control file' % ((head, tail), ))
1589
if tail == bzrlib.BZRDIR:
1282
def bind(self, other):
1283
"""Bind the local branch the other branch.
1285
:param other: The branch to bind to
1288
# TODO: jam 20051230 Consider checking if the target is bound
1289
# It is debatable whether you should be able to bind to
1290
# a branch which is itself bound.
1291
# Committing is obviously forbidden,
1292
# but binding itself may not be.
1293
# Since we *have* to check at commit time, we don't
1294
# *need* to check here
1297
# we are now equal to or a suffix of other.
1299
# Since we have 'pulled' from the remote location,
1300
# now we should try to pull in the opposite direction
1301
# in case the local tree has more revisions than the
1303
# There may be a different check you could do here
1304
# rather than actually trying to install revisions remotely.
1305
# TODO: capture an exception which indicates the remote branch
1307
# If it is up-to-date, this probably should not be a failure
1309
# lock other for write so the revision-history syncing cannot race
1313
# if this does not error, other now has the same last rev we do
1314
# it can only error if the pull from other was concurrent with
1315
# a commit to other from someone else.
1317
# until we ditch revision-history, we need to sync them up:
1318
self.set_revision_history(other.revision_history())
1319
# now other and self are up to date with each other and have the
1320
# same revision-history.
1324
self.set_bound_location(other.base)
1328
"""If bound, unbind"""
1329
return self.set_bound_location(None)
1333
"""Synchronise this branch with the master branch if any.
1335
:return: None or the last_revision that was pivoted out during the
1338
master = self.get_master_branch()
1339
if master is not None:
1340
old_tip = self.last_revision()
1341
self.pull(master, overwrite=True)
1342
if old_tip in self.repository.get_ancestry(self.last_revision()):
1348
class BranchTestProviderAdapter(object):
1349
"""A tool to generate a suite testing multiple branch formats at once.
1351
This is done by copying the test once for each transport and injecting
1352
the transport_server, transport_readonly_server, and branch_format
1353
classes into each copy. Each copy is also given a new id() to make it
1591
if filename == head:
1598
def gen_file_id(name):
1599
"""Return new file id.
1601
This should probably generate proper UUIDs, but for the moment we
1602
cope with just randomness because running uuidgen every time is
1605
from binascii import hexlify
1606
from time import time
1608
# get last component
1609
idx = name.rfind('/')
1611
name = name[idx+1 : ]
1612
idx = name.rfind('\\')
1614
name = name[idx+1 : ]
1616
# make it not a hidden file
1617
name = name.lstrip('.')
1619
# remove any wierd characters; we don't escape them but rather
1620
# just pull them out
1621
name = re.sub(r'[^\w.]', '', name)
1623
s = hexlify(rand_bytes(8))
1624
return '-'.join((name, compact_date(time()), s))
1628
"""Return a new tree-root file id."""
1629
return gen_file_id('TREE_ROOT')
1632
def copy_branch(branch_from, to_location, revision=None):
1633
"""Copy branch_from into the existing directory to_location.
1636
If not None, only revisions up to this point will be copied.
1637
The head of the new branch will be that revision.
1640
The name of a local directory that exists but is empty.
1642
from bzrlib.merge import merge
1357
def __init__(self, transport_server, transport_readonly_server, formats):
1358
self._transport_server = transport_server
1359
self._transport_readonly_server = transport_readonly_server
1360
self._formats = formats
1644
assert isinstance(branch_from, Branch)
1645
assert isinstance(to_location, basestring)
1362
def adapt(self, test):
1363
result = TestSuite()
1364
for branch_format, bzrdir_format in self._formats:
1365
new_test = deepcopy(test)
1366
new_test.transport_server = self._transport_server
1367
new_test.transport_readonly_server = self._transport_readonly_server
1368
new_test.bzrdir_format = bzrdir_format
1369
new_test.branch_format = branch_format
1370
def make_new_test_id():
1371
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1372
return lambda: new_id
1373
new_test.id = make_new_test_id()
1374
result.addTest(new_test)
1378
class BranchCheckResult(object):
1379
"""Results of checking branch consistency.
1384
def __init__(self, branch):
1385
self.branch = branch
1387
def report_results(self, verbose):
1388
"""Report the check results via trace.note.
1390
:param verbose: Requests more detailed display of what was checked,
1393
note('checked branch %s format %s',
1395
self.branch._format)
1398
######################################################################
1402
@deprecated_function(zero_eight)
1403
def is_control_file(*args, **kwargs):
1404
"""See bzrlib.workingtree.is_control_file."""
1405
return bzrlib.workingtree.is_control_file(*args, **kwargs)
1647
br_to = Branch(to_location, init=True)
1648
br_to.set_root_id(branch_from.get_root_id())
1649
if revision is None:
1650
revno = branch_from.revno()
1652
revno, rev_id = branch_from.get_revision_info(revision)
1653
br_to.update_revisions(branch_from, stop_revision=revno)
1654
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1655
check_clean=False, ignore_zero=True)
1656
br_to.set_parent(branch_from.base)
1659
def _trim_namespace(namespace, spec):
1660
full_namespace = namespace + ':'
1661
assert spec.startswith(full_namespace)
1662
return spec[len(full_namespace):]