1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from cStringIO import StringIO
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout
35
from textui import show_status
36
from diff import diff_trees
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
46
It is not necessary that f exists.
48
Basically we keep looking up until we find the control directory or
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
55
f = os.path.abspath(f)
61
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
63
head, tail = os.path.split(f)
65
# reached the root, whatever that may be
66
bailout('%r is not in a branch' % orig_f)
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
63
from bzrlib.trace import mutter, note
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
71
80
######################################################################
75
84
"""Branch holding a history of revisions.
77
:todo: Perhaps use different stores for different classes of object,
78
so that we can keep track of how much space each one uses,
79
or garbage-collect them.
81
:todo: Add a RemoteBranch subclass. For the basic case of read-only
82
HTTP access this should be very easy by,
83
just redirecting controlfile access into HTTP requests.
84
We would need a RemoteStore working similarly.
86
:todo: Keep the on-disk branch locked while the object exists.
88
:todo: mkdir() method.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
90
def __init__(self, base, init=False, find_root=True):
91
"""Create new branch object at a particular location.
93
:param base: Base directory for the branch.
95
:param init: If True, create new control files in a previously
96
unversioned directory. If False, the branch must already
99
:param find_root: If true and init is false, find the root of the
100
existing branch containing base.
102
In the test suite, creation of new trees is tested using the
103
`ScratchBranch` class.
106
self.base = os.path.realpath(base)
109
self.base = find_branch_root(base)
111
self.base = os.path.realpath(base)
112
if not isdir(self.controlfilename('.')):
113
bailout("not a bzr branch: %s" % quotefn(base),
114
['use "bzr init" to initialize a new working tree',
115
'current bzr can only operate from top-of-tree'])
118
self.text_store = ImmutableStore(self.controlfilename('text-store'))
119
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
120
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
124
return '%s(%r)' % (self.__class__.__name__, self.base)
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
self._revision_history_cache = None
103
def break_lock(self):
104
"""Break a lock if one is present from another instance.
106
Uses the ui factory to ask for confirmation if the lock may be from
109
This will probe the repository for its lock as well.
111
self.control_files.break_lock()
112
self.repository.break_lock()
113
master = self.get_master_branch()
114
if master is not None:
118
@deprecated_method(zero_eight)
119
def open_downlevel(base):
120
"""Open a branch which may be of an old format."""
121
return Branch.open(base, _unsupported=True)
124
def open(base, _unsupported=False):
125
"""Open the branch rooted at base.
127
For instance, if the branch is at URL/.bzr/branch,
128
Branch.open(URL) -> a Branch instance.
130
control = bzrdir.BzrDir.open(base, _unsupported)
131
return control.open_branch(_unsupported)
134
def open_containing(url):
135
"""Open an existing branch which contains url.
137
This probes for a branch at url, and searches upwards from there.
139
Basically we keep looking up until we find the control directory or
140
run into the root. If there isn't one, raises NotBranchError.
141
If there is one and it is either an unrecognised format or an unsupported
142
format, UnknownFormatError or UnsupportedFormatError are raised.
143
If there is one, it is returned, along with the unused portion of url.
145
control, relpath = bzrdir.BzrDir.open_containing(url)
146
return control.open_branch(), relpath
149
@deprecated_function(zero_eight)
150
def initialize(base):
151
"""Create a new working tree and branch, rooted at 'base' (url)
153
NOTE: This will soon be deprecated in favour of creation
156
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
158
@deprecated_function(zero_eight)
159
def setup_caching(self, cache_root):
160
"""Subclasses that care about caching should override this, and set
161
up cached stores located under cache_root.
163
NOTE: This is unused.
167
def get_config(self):
168
return BranchConfig(self)
171
return self.get_config().get_nickname()
173
def _set_nick(self, nick):
174
self.get_config().set_user_option('nickname', nick)
176
nick = property(_get_nick, _set_nick)
179
raise NotImplementedError(self.is_locked)
181
def lock_write(self):
182
raise NotImplementedError(self.lock_write)
185
raise NotImplementedError(self.lock_read)
188
raise NotImplementedError(self.unlock)
190
def peek_lock_mode(self):
191
"""Return lock mode for the Branch: 'r', 'w' or None"""
192
raise NotImplementedError(self.peek_lock_mode)
194
def get_physical_lock_status(self):
195
raise NotImplementedError(self.get_physical_lock_status)
130
197
def abspath(self, name):
131
"""Return absolute filename for something in the branch"""
132
return os.path.join(self.base, name)
135
def relpath(self, path):
136
"""Return path relative to this branch of something inside it.
138
Raises an error if path is not in this branch."""
139
rp = os.path.realpath(path)
141
if not rp.startswith(self.base):
142
bailout("path %r is not within branch %r" % (rp, self.base))
143
rp = rp[len(self.base):]
144
rp = rp.lstrip(os.sep)
148
def controlfilename(self, file_or_path):
149
"""Return location relative to branch."""
150
if isinstance(file_or_path, types.StringTypes):
151
file_or_path = [file_or_path]
152
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
155
def controlfile(self, file_or_path, mode='r'):
156
"""Open a control file for this branch"""
157
return file(self.controlfilename(file_or_path), mode)
160
def _make_control(self):
161
os.mkdir(self.controlfilename([]))
162
self.controlfile('README', 'w').write(
163
"This is a Bazaar-NG control directory.\n"
164
"Do not change any files in this directory.")
165
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
166
for d in ('text-store', 'inventory-store', 'revision-store'):
167
os.mkdir(self.controlfilename(d))
168
for f in ('revision-history', 'merged-patches',
169
'pending-merged-patches', 'branch-name'):
170
self.controlfile(f, 'w').write('')
171
mutter('created control directory in ' + self.base)
172
Inventory().write_xml(self.controlfile('inventory','w'))
175
def _check_format(self):
176
"""Check this branch format is supported.
178
The current tool only supports the current unstable format.
180
In the future, we might need different in-memory Branch
181
classes to support downlevel branches. But not yet.
183
# read in binary mode to detect newline wierdness.
184
fmt = self.controlfile('branch-format', 'rb').read()
185
if fmt != BZR_BRANCH_FORMAT:
186
bailout('sorry, branch format %r not supported' % fmt,
187
['use a different bzr version',
188
'or remove the .bzr directory and "bzr init" again'])
191
def read_working_inventory(self):
192
"""Read the working inventory."""
194
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
195
mutter("loaded inventory of %d items in %f"
196
% (len(inv), time.time() - before))
200
def _write_inventory(self, inv):
201
"""Update the working inventory.
203
That is to say, the inventory describing changes underway, that
204
will be committed to the next revision.
206
## TODO: factor out to atomicfile? is rename safe on windows?
207
## TODO: Maybe some kind of clean/dirty marker on inventory?
208
tmpfname = self.controlfilename('inventory.tmp')
209
tmpf = file(tmpfname, 'w')
212
os.rename(tmpfname, self.controlfilename('inventory'))
213
mutter('wrote working inventory')
216
inventory = property(read_working_inventory, _write_inventory, None,
217
"""Inventory for the working copy.""")
220
def add(self, files, verbose=False):
221
"""Make files versioned.
223
This puts the files in the Added state, so that they will be
224
recorded by the next commit.
226
:todo: Perhaps have an option to add the ids even if the files do
229
:todo: Perhaps return the ids of the files? But then again it
230
is easy to retrieve them if they're needed.
232
:todo: Option to specify file id.
234
:todo: Adding a directory should optionally recurse down and
235
add all non-ignored children. Perhaps do that in a
238
>>> b = ScratchBranch(files=['foo'])
239
>>> 'foo' in b.unknowns()
244
>>> 'foo' in b.unknowns()
246
>>> bool(b.inventory.path2id('foo'))
252
Traceback (most recent call last):
254
BzrError: ('foo is already versioned', [])
256
>>> b.add(['nothere'])
257
Traceback (most recent call last):
258
BzrError: ('cannot add: not a regular file or directory: nothere', [])
261
# TODO: Re-adding a file that is removed in the working copy
262
# should probably put it back with the previous ID.
263
if isinstance(files, types.StringTypes):
266
inv = self.read_working_inventory()
268
if is_control_file(f):
269
bailout("cannot add control file %s" % quotefn(f))
274
bailout("cannot add top-level %r" % f)
276
fullpath = os.path.normpath(self.abspath(f))
279
kind = file_kind(fullpath)
281
# maybe something better?
282
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
284
if kind != 'file' and kind != 'directory':
285
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
287
file_id = gen_file_id(f)
288
inv.add_path(f, kind=kind, file_id=file_id)
291
show_status('A', kind, quotefn(f))
293
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
295
self._write_inventory(inv)
299
def remove(self, files, verbose=False):
300
"""Mark nominated files for removal from the inventory.
302
This does not remove their text. This does not run on
304
:todo: Refuse to remove modified files unless --force is given?
306
>>> b = ScratchBranch(files=['foo'])
308
>>> b.inventory.has_filename('foo')
311
>>> b.working_tree().has_filename('foo')
313
>>> b.inventory.has_filename('foo')
316
>>> b = ScratchBranch(files=['foo'])
321
>>> b.inventory.has_filename('foo')
323
>>> b.basis_tree().has_filename('foo')
325
>>> b.working_tree().has_filename('foo')
328
:todo: Do something useful with directories.
330
:todo: Should this remove the text or not? Tough call; not
331
removing may be useful and the user can just use use rm, and
332
is the opposite of add. Removing it is consistent with most
333
other tools. Maybe an option.
335
## TODO: Normalize names
336
## TODO: Remove nested loops; better scalability
338
if isinstance(files, types.StringTypes):
341
tree = self.working_tree()
344
# do this before any modifications
348
bailout("cannot remove unversioned file %s" % quotefn(f))
349
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
351
# having remove it, it must be either ignored or unknown
352
if tree.is_ignored(f):
356
show_status(new_status, inv[fid].kind, quotefn(f))
359
self._write_inventory(inv)
363
"""Return all unknown files.
365
These are files in the working directory that are not versioned or
366
control files or ignored.
368
>>> b = ScratchBranch(files=['foo', 'foo~'])
369
>>> list(b.unknowns())
372
>>> list(b.unknowns())
375
>>> list(b.unknowns())
378
return self.working_tree().unknowns()
381
def commit(self, message, timestamp=None, timezone=None,
384
"""Commit working copy as a new revision.
386
The basic approach is to add all the file texts into the
387
store, then the inventory, then make a new revision pointing
388
to that inventory and store that.
390
This is not quite safe if the working copy changes during the
391
commit; for the moment that is simply not allowed. A better
392
approach is to make a temporary copy of the files before
393
computing their hashes, and then add those hashes in turn to
394
the inventory. This should mean at least that there are no
395
broken hash pointers. There is no way we can get a snapshot
396
of the whole directory at an instant. This would also have to
397
be robust against files disappearing, moving, etc. So the
398
whole thing is a bit hard.
400
:param timestamp: if not None, seconds-since-epoch for a
401
postdated/predated commit.
404
## TODO: Show branch names
406
# TODO: Don't commit if there are no changes, unless forced?
408
# First walk over the working inventory; and both update that
409
# and also build a new revision inventory. The revision
410
# inventory needs to hold the text-id, sha1 and size of the
411
# actual file versions committed in the revision. (These are
412
# not present in the working inventory.) We also need to
413
# detect missing/deleted files, and remove them from the
416
work_inv = self.read_working_inventory()
418
basis = self.basis_tree()
419
basis_inv = basis.inventory
421
for path, entry in work_inv.iter_entries():
422
## TODO: Cope with files that have gone missing.
424
## TODO: Check that the file kind has not changed from the previous
425
## revision of this file (if any).
429
p = self.abspath(path)
430
file_id = entry.file_id
431
mutter('commit prep file %s, id %r ' % (p, file_id))
433
if not os.path.exists(p):
434
mutter(" file is missing, removing from inventory")
436
show_status('D', entry.kind, quotefn(path))
437
missing_ids.append(file_id)
440
# TODO: Handle files that have been deleted
442
# TODO: Maybe a special case for empty files? Seems a
443
# waste to store them many times.
447
if basis_inv.has_id(file_id):
448
old_kind = basis_inv[file_id].kind
449
if old_kind != entry.kind:
450
bailout("entry %r changed kind from %r to %r"
451
% (file_id, old_kind, entry.kind))
453
if entry.kind == 'directory':
455
bailout("%s is entered as directory but not a directory" % quotefn(p))
456
elif entry.kind == 'file':
458
bailout("%s is entered as file but is not a file" % quotefn(p))
460
content = file(p, 'rb').read()
462
entry.text_sha1 = sha_string(content)
463
entry.text_size = len(content)
465
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
467
and (old_ie.text_size == entry.text_size)
468
and (old_ie.text_sha1 == entry.text_sha1)):
469
## assert content == basis.get_file(file_id).read()
470
entry.text_id = basis_inv[file_id].text_id
471
mutter(' unchanged from previous text_id {%s}' %
475
entry.text_id = gen_file_id(entry.name)
476
self.text_store.add(content, entry.text_id)
477
mutter(' stored with text_id {%s}' % entry.text_id)
481
elif (old_ie.name == entry.name
482
and old_ie.parent_id == entry.parent_id):
487
show_status(state, entry.kind, quotefn(path))
489
for file_id in missing_ids:
490
# have to do this later so we don't mess up the iterator.
491
# since parents may be removed before their children we
494
# FIXME: There's probably a better way to do this; perhaps
495
# the workingtree should know how to filter itself.
496
if work_inv.has_id(file_id):
497
del work_inv[file_id]
500
inv_id = rev_id = _gen_revision_id(time.time())
502
inv_tmp = tempfile.TemporaryFile()
503
inv.write_xml(inv_tmp)
505
self.inventory_store.add(inv_tmp, inv_id)
506
mutter('new inventory_id is {%s}' % inv_id)
508
self._write_inventory(work_inv)
510
if timestamp == None:
511
timestamp = time.time()
513
if committer == None:
514
committer = username()
517
timezone = local_time_offset()
519
mutter("building commit log message")
520
rev = Revision(timestamp=timestamp,
523
precursor = self.last_patch(),
528
rev_tmp = tempfile.TemporaryFile()
529
rev.write_xml(rev_tmp)
531
self.revision_store.add(rev_tmp, rev_id)
532
mutter("new revision_id is {%s}" % rev_id)
534
## XXX: Everything up to here can simply be orphaned if we abort
535
## the commit; it will leave junk files behind but that doesn't
538
## TODO: Read back the just-generated changeset, and make sure it
539
## applies and recreates the right state.
541
## TODO: Also calculate and store the inventory SHA1
542
mutter("committing patch r%d" % (self.revno() + 1))
544
mutter("append to revision-history")
545
f = self.controlfile('revision-history', 'at')
546
f.write(rev_id + '\n')
550
note("commited r%d" % self.revno())
553
def get_revision(self, revision_id):
554
"""Return the Revision object for a named revision"""
555
r = Revision.read_xml(self.revision_store[revision_id])
556
assert r.revision_id == revision_id
560
def get_inventory(self, inventory_id):
561
"""Get Inventory object by hash.
563
:todo: Perhaps for this and similar methods, take a revision
564
parameter which can be either an integer revno or a
566
i = Inventory.read_xml(self.inventory_store[inventory_id])
570
def get_revision_inventory(self, revision_id):
571
"""Return inventory of a past revision."""
572
if revision_id == None:
198
"""Return absolute filename for something in the branch
200
XXX: Robert Collins 20051017 what is this used for? why is it a branch
201
method and not a tree method.
203
raise NotImplementedError(self.abspath)
205
def bind(self, other):
206
"""Bind the local branch the other branch.
208
:param other: The branch to bind to
211
raise errors.UpgradeRequired(self.base)
214
def fetch(self, from_branch, last_revision=None, pb=None):
215
"""Copy revisions from from_branch into this branch.
217
:param from_branch: Where to copy from.
218
:param last_revision: What revision to stop at (None for at the end
220
:param pb: An optional progress bar to use.
222
Returns the copied revision count and the failed revisions in a tuple:
225
if self.base == from_branch.base:
228
nested_pb = ui.ui_factory.nested_progress_bar()
575
return self.get_inventory(self.get_revision(revision_id).inventory_id)
233
from_branch.lock_read()
235
if last_revision is None:
236
pb.update('get source history')
237
last_revision = from_branch.last_revision()
238
if last_revision is None:
239
last_revision = _mod_revision.NULL_REVISION
240
return self.repository.fetch(from_branch.repository,
241
revision_id=last_revision,
244
if nested_pb is not None:
248
def get_bound_location(self):
249
"""Return the URL of the branch we are bound to.
251
Older format branches cannot bind, please be sure to use a metadir
256
def get_old_bound_location(self):
257
"""Return the URL of the branch we used to be bound to
259
raise errors.UpgradeRequired(self.base)
261
def get_commit_builder(self, parents, config=None, timestamp=None,
262
timezone=None, committer=None, revprops=None,
264
"""Obtain a CommitBuilder for this branch.
266
:param parents: Revision ids of the parents of the new revision.
267
:param config: Optional configuration to use.
268
:param timestamp: Optional timestamp recorded for commit.
269
:param timezone: Optional timezone for timestamp.
270
:param committer: Optional committer to set for commit.
271
:param revprops: Optional dictionary of revision properties.
272
:param revision_id: Optional revision id.
276
config = self.get_config()
278
return self.repository.get_commit_builder(self, parents, config,
279
timestamp, timezone, committer, revprops, revision_id)
281
def get_master_branch(self):
282
"""Return the branch we are bound to.
284
:return: Either a Branch, or None
288
def get_revision_delta(self, revno):
289
"""Return the delta for one revision.
291
The delta is relative to its mainline predecessor, or the
292
empty tree for revision 1.
294
assert isinstance(revno, int)
295
rh = self.revision_history()
296
if not (1 <= revno <= len(rh)):
297
raise InvalidRevisionNumber(revno)
298
return self.repository.get_revision_delta(rh[revno-1])
300
@deprecated_method(zero_sixteen)
301
def get_root_id(self):
302
"""Return the id of this branches root
304
Deprecated: branches don't have root ids-- trees do.
305
Use basis_tree().get_root_id() instead.
307
raise NotImplementedError(self.get_root_id)
309
def print_file(self, file, revision_id):
310
"""Print `file` to stdout."""
311
raise NotImplementedError(self.print_file)
313
def append_revision(self, *revision_ids):
314
raise NotImplementedError(self.append_revision)
316
def set_revision_history(self, rev_history):
317
raise NotImplementedError(self.set_revision_history)
319
def _cache_revision_history(self, rev_history):
320
"""Set the cached revision history to rev_history.
322
The revision_history method will use this cache to avoid regenerating
323
the revision history.
325
This API is semi-public; it only for use by subclasses, all other code
326
should consider it to be private.
328
self._revision_history_cache = rev_history
330
def _clear_cached_state(self):
331
"""Clear any cached data on this branch, e.g. cached revision history.
333
This means the next call to revision_history will need to call
334
_gen_revision_history.
336
This API is semi-public; it only for use by subclasses, all other code
337
should consider it to be private.
339
self._revision_history_cache = None
341
def _gen_revision_history(self):
342
"""Return sequence of revision hashes on to this branch.
344
Unlike revision_history, this method always regenerates or rereads the
345
revision history, i.e. it does not cache the result, so repeated calls
348
Concrete subclasses should override this instead of revision_history so
349
that subclasses do not need to deal with caching logic.
351
This API is semi-public; it only for use by subclasses, all other code
352
should consider it to be private.
354
raise NotImplementedError(self._gen_revision_history)
578
357
def revision_history(self):
579
358
"""Return sequence of revision hashes on to this branch.
581
>>> ScratchBranch().revision_history()
360
This method will cache the revision history for as long as it is safe to
584
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
363
if self._revision_history_cache is not None:
364
history = self._revision_history_cache
366
history = self._gen_revision_history()
367
self._cache_revision_history(history)
588
371
"""Return current revision number for this branch.
590
373
That is equivalent to the number of revisions committed to
593
>>> b = ScratchBranch()
596
>>> b.commit('no foo')
600
376
return len(self.revision_history())
603
def last_patch(self):
604
"""Return last patch hash, or None if no history.
606
>>> ScratchBranch().last_patch() == None
379
"""Older format branches cannot bind or unbind."""
380
raise errors.UpgradeRequired(self.base)
382
def set_append_revisions_only(self, enabled):
383
"""Older format branches are never restricted to append-only"""
384
raise errors.UpgradeRequired(self.base)
386
def last_revision(self):
387
"""Return last revision id, or None"""
609
388
ph = self.revision_history()
614
def lookup_revision(self, revno):
615
"""Return revision hash for revision number."""
394
def last_revision_info(self):
395
"""Return information about the last revision.
397
:return: A tuple (revno, last_revision_id).
399
rh = self.revision_history()
402
return (revno, rh[-1])
404
return (0, _mod_revision.NULL_REVISION)
406
def missing_revisions(self, other, stop_revision=None):
407
"""Return a list of new revisions that would perfectly fit.
409
If self and other have not diverged, return a list of the revisions
410
present in other, but missing from self.
412
self_history = self.revision_history()
413
self_len = len(self_history)
414
other_history = other.revision_history()
415
other_len = len(other_history)
416
common_index = min(self_len, other_len) -1
417
if common_index >= 0 and \
418
self_history[common_index] != other_history[common_index]:
419
raise DivergedBranches(self, other)
421
if stop_revision is None:
422
stop_revision = other_len
424
assert isinstance(stop_revision, int)
425
if stop_revision > other_len:
426
raise errors.NoSuchRevision(self, stop_revision)
427
return other_history[self_len:stop_revision]
429
def update_revisions(self, other, stop_revision=None):
430
"""Pull in new perfect-fit revisions.
432
:param other: Another Branch to pull from
433
:param stop_revision: Updated until the given revision
436
raise NotImplementedError(self.update_revisions)
438
def revision_id_to_revno(self, revision_id):
439
"""Given a revision id, return its revno"""
440
if revision_id is None:
442
revision_id = osutils.safe_revision_id(revision_id)
443
history = self.revision_history()
445
return history.index(revision_id) + 1
447
raise bzrlib.errors.NoSuchRevision(self, revision_id)
449
def get_rev_id(self, revno, history=None):
450
"""Find the revision id of the specified revno."""
620
# list is 0-based; revisions are 1-based
621
return self.revision_history()[revno-1]
623
bailout("no such revision %s" % revno)
626
def revision_tree(self, revision_id):
627
"""Return Tree for a revision on this branch.
629
`revision_id` may be None for the null revision, in which case
630
an `EmptyTree` is returned."""
632
if revision_id == None:
635
inv = self.get_revision_inventory(revision_id)
636
return RevisionTree(self.text_store, inv)
454
history = self.revision_history()
455
if revno <= 0 or revno > len(history):
456
raise bzrlib.errors.NoSuchRevision(self, revno)
457
return history[revno - 1]
459
def pull(self, source, overwrite=False, stop_revision=None):
460
"""Mirror source into this branch.
462
This branch is considered to be 'local', having low latency.
464
:returns: PullResult instance
466
raise NotImplementedError(self.pull)
468
def push(self, target, overwrite=False, stop_revision=None):
469
"""Mirror this branch into target.
471
This branch is considered to be 'local', having low latency.
473
raise NotImplementedError(self.push)
475
def basis_tree(self):
476
"""Return `Tree` object for last revision."""
477
return self.repository.revision_tree(self.last_revision())
479
def rename_one(self, from_rel, to_rel):
482
This can change the directory or the filename or both.
484
raise NotImplementedError(self.rename_one)
486
def move(self, from_paths, to_name):
489
to_name must exist as a versioned directory.
491
If to_name exists and is a directory, the files are moved into
492
it, keeping their old names. If it is a directory,
494
Note that to_name is only the last component of the new name;
495
this doesn't change the directory.
497
This returns a list of (from_path, to_path) pairs for each
500
raise NotImplementedError(self.move)
502
def get_parent(self):
503
"""Return the parent location of the branch.
505
This is the default location for push/pull/missing. The usual
506
pattern is that the user can override it by specifying a
509
raise NotImplementedError(self.get_parent)
511
def _set_config_location(self, name, url, config=None,
512
make_relative=False):
514
config = self.get_config()
518
url = urlutils.relative_url(self.base, url)
519
config.set_user_option(name, url)
521
def _get_config_location(self, name, config=None):
523
config = self.get_config()
524
location = config.get_user_option(name)
529
def get_submit_branch(self):
530
"""Return the submit location of the branch.
532
This is the default location for bundle. The usual
533
pattern is that the user can override it by specifying a
536
return self.get_config().get_user_option('submit_branch')
538
def set_submit_branch(self, location):
539
"""Return the submit location of the branch.
541
This is the default location for bundle. The usual
542
pattern is that the user can override it by specifying a
545
self.get_config().set_user_option('submit_branch', location)
547
def get_public_branch(self):
548
"""Return the public location of the branch.
550
This is is used by merge directives.
552
return self._get_config_location('public_branch')
554
def set_public_branch(self, location):
555
"""Return the submit location of the branch.
557
This is the default location for bundle. The usual
558
pattern is that the user can override it by specifying a
561
self._set_config_location('public_branch', location)
563
def get_push_location(self):
564
"""Return the None or the location to push this branch to."""
565
raise NotImplementedError(self.get_push_location)
567
def set_push_location(self, location):
568
"""Set a new push location for this branch."""
569
raise NotImplementedError(self.set_push_location)
571
def set_parent(self, url):
572
raise NotImplementedError(self.set_parent)
576
"""Synchronise this branch with the master branch if any.
578
:return: None or the last_revision pivoted out during the update.
582
def check_revno(self, revno):
584
Check whether a revno corresponds to any revision.
585
Zero (the NULL revision) is considered valid.
588
self.check_real_revno(revno)
590
def check_real_revno(self, revno):
592
Check whether a revno corresponds to a real revision.
593
Zero (the NULL revision) is considered invalid
595
if revno < 1 or revno > self.revno():
596
raise InvalidRevisionNumber(revno)
599
def clone(self, to_bzrdir, revision_id=None):
600
"""Clone this branch into to_bzrdir preserving all semantic values.
602
revision_id: if not None, the revision history in the new branch will
603
be truncated to end with revision_id.
605
result = self._format.initialize(to_bzrdir)
606
self.copy_content_into(result, revision_id=revision_id)
610
def sprout(self, to_bzrdir, revision_id=None):
611
"""Create a new line of development from the branch, into to_bzrdir.
613
revision_id: if not None, the revision history in the new branch will
614
be truncated to end with revision_id.
616
result = self._format.initialize(to_bzrdir)
617
self.copy_content_into(result, revision_id=revision_id)
618
result.set_parent(self.bzrdir.root_transport.base)
621
def _synchronize_history(self, destination, revision_id):
622
"""Synchronize last revision and revision history between branches.
624
This version is most efficient when the destination is also a
625
BzrBranch5, but works for BzrBranch6 as long as the revision
626
history is the true lefthand parent history, and all of the revisions
627
are in the destination's repository. If not, set_revision_history
630
:param destination: The branch to copy the history into
631
:param revision_id: The revision-id to truncate history at. May
632
be None to copy complete history.
634
new_history = self.revision_history()
635
if revision_id is not None:
636
revision_id = osutils.safe_revision_id(revision_id)
638
new_history = new_history[:new_history.index(revision_id) + 1]
640
rev = self.repository.get_revision(revision_id)
641
new_history = rev.get_history(self.repository)[1:]
642
destination.set_revision_history(new_history)
645
def copy_content_into(self, destination, revision_id=None):
646
"""Copy the content of self into destination.
648
revision_id: if not None, the revision history in the new branch will
649
be truncated to end with revision_id.
651
self._synchronize_history(destination, revision_id)
653
parent = self.get_parent()
654
except errors.InaccessibleParent, e:
655
mutter('parent was not accessible to copy: %s', e)
658
destination.set_parent(parent)
659
self.tags.merge_to(destination.tags)
663
"""Check consistency of the branch.
665
In particular this checks that revisions given in the revision-history
666
do actually match up in the revision graph, and that they're all
667
present in the repository.
669
Callers will typically also want to check the repository.
671
:return: A BranchCheckResult.
673
mainline_parent_id = None
674
for revision_id in self.revision_history():
676
revision = self.repository.get_revision(revision_id)
677
except errors.NoSuchRevision, e:
678
raise errors.BzrCheckError("mainline revision {%s} not in repository"
680
# In general the first entry on the revision history has no parents.
681
# But it's not illegal for it to have parents listed; this can happen
682
# in imports from Arch when the parents weren't reachable.
683
if mainline_parent_id is not None:
684
if mainline_parent_id not in revision.parent_ids:
685
raise errors.BzrCheckError("previous revision {%s} not listed among "
687
% (mainline_parent_id, revision_id))
688
mainline_parent_id = revision_id
689
return BranchCheckResult(self)
691
def _get_checkout_format(self):
692
"""Return the most suitable metadir for a checkout of this branch.
693
Weaves are used if this branch's repostory uses weaves.
695
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
696
from bzrlib.repofmt import weaverepo
697
format = bzrdir.BzrDirMetaFormat1()
698
format.repository_format = weaverepo.RepositoryFormat7()
700
format = self.repository.bzrdir.checkout_metadir()
701
format.set_branch_format(self._format)
704
def create_checkout(self, to_location, revision_id=None,
706
"""Create a checkout of a branch.
708
:param to_location: The url to produce the checkout at
709
:param revision_id: The revision to check out
710
:param lightweight: If True, produce a lightweight checkout, otherwise,
711
produce a bound branch (heavyweight checkout)
712
:return: The tree of the created checkout
714
t = transport.get_transport(to_location)
717
except errors.FileExists:
720
format = self._get_checkout_format()
721
checkout = format.initialize_on_transport(t)
722
BranchReferenceFormat().initialize(checkout, self)
724
format = self._get_checkout_format()
725
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
726
to_location, force_new_tree=False, format=format)
727
checkout = checkout_branch.bzrdir
728
checkout_branch.bind(self)
729
# pull up to the specified revision_id to set the initial
730
# branch tip correctly, and seed it with history.
731
checkout_branch.pull(self, stop_revision=revision_id)
732
tree = checkout.create_workingtree(revision_id)
733
basis_tree = tree.basis_tree()
734
basis_tree.lock_read()
736
for path, file_id in basis_tree.iter_references():
737
reference_parent = self.reference_parent(file_id, path)
738
reference_parent.create_checkout(tree.abspath(path),
739
basis_tree.get_reference_revision(file_id, path),
745
def reference_parent(self, file_id, path):
746
"""Return the parent branch for a tree-reference file_id
747
:param file_id: The file_id of the tree reference
748
:param path: The path of the file_id in the tree
749
:return: A branch associated with the file_id
751
# FIXME should provide multiple branches, based on config
752
return Branch.open(self.bzrdir.root_transport.clone(path).base)
754
def supports_tags(self):
755
return self._format.supports_tags()
758
class BranchFormat(object):
759
"""An encapsulation of the initialization and open routines for a format.
761
Formats provide three things:
762
* An initialization routine,
766
Formats are placed in an dict by their format string for reference
767
during branch opening. Its not required that these be instances, they
768
can be classes themselves with class methods - it simply depends on
769
whether state is needed for a given format or not.
771
Once a format is deprecated, just deprecate the initialize and open
772
methods on the format class. Do not deprecate the object, as the
773
object will be created every time regardless.
776
_default_format = None
777
"""The default format used for new branches."""
780
"""The known formats."""
783
def find_format(klass, a_bzrdir):
784
"""Return the format for the branch object in a_bzrdir."""
786
transport = a_bzrdir.get_branch_transport(None)
787
format_string = transport.get("format").read()
788
return klass._formats[format_string]
790
raise NotBranchError(path=transport.base)
792
raise errors.UnknownFormatError(format=format_string)
795
def get_default_format(klass):
796
"""Return the current default format."""
797
return klass._default_format
799
def get_format_string(self):
800
"""Return the ASCII format string that identifies this format."""
801
raise NotImplementedError(self.get_format_string)
803
def get_format_description(self):
804
"""Return the short format description for this format."""
805
raise NotImplementedError(self.get_format_description)
807
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
809
"""Initialize a branch in a bzrdir, with specified files
811
:param a_bzrdir: The bzrdir to initialize the branch in
812
:param utf8_files: The files to create as a list of
813
(filename, content) tuples
814
:param set_format: If True, set the format with
815
self.get_format_string. (BzrBranch4 has its format set
817
:return: a branch in this format
819
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
820
branch_transport = a_bzrdir.get_branch_transport(self)
822
'metadir': ('lock', lockdir.LockDir),
823
'branch4': ('branch-lock', lockable_files.TransportLock),
825
lock_name, lock_class = lock_map[lock_type]
826
control_files = lockable_files.LockableFiles(branch_transport,
827
lock_name, lock_class)
828
control_files.create_lock()
829
control_files.lock_write()
831
control_files.put_utf8('format', self.get_format_string())
833
for file, content in utf8_files:
834
control_files.put_utf8(file, content)
836
control_files.unlock()
837
return self.open(a_bzrdir, _found=True)
839
def initialize(self, a_bzrdir):
840
"""Create a branch of this format in a_bzrdir."""
841
raise NotImplementedError(self.initialize)
843
def is_supported(self):
844
"""Is this format supported?
846
Supported formats can be initialized and opened.
847
Unsupported formats may not support initialization or committing or
848
some other features depending on the reason for not being supported.
852
def open(self, a_bzrdir, _found=False):
853
"""Return the branch object for a_bzrdir
855
_found is a private parameter, do not use it. It is used to indicate
856
if format probing has already be done.
858
raise NotImplementedError(self.open)
861
def register_format(klass, format):
862
klass._formats[format.get_format_string()] = format
865
def set_default_format(klass, format):
866
klass._default_format = format
869
def unregister_format(klass, format):
870
assert klass._formats[format.get_format_string()] is format
871
del klass._formats[format.get_format_string()]
874
return self.get_format_string().rstrip()
876
def supports_tags(self):
877
"""True if this format supports tags stored in the branch"""
878
return False # by default
880
# XXX: Probably doesn't really belong here -- mbp 20070212
881
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
883
branch_transport = a_bzrdir.get_branch_transport(self)
884
control_files = lockable_files.LockableFiles(branch_transport,
885
lock_filename, lock_class)
886
control_files.create_lock()
887
control_files.lock_write()
889
for filename, content in utf8_files:
890
control_files.put_utf8(filename, content)
892
control_files.unlock()
895
class BranchHooks(dict):
896
"""A dictionary mapping hook name to a list of callables for branch hooks.
898
e.g. ['set_rh'] Is the list of items to be called when the
899
set_revision_history function is invoked.
903
"""Create the default hooks.
905
These are all empty initially, because by default nothing should get
909
# Introduced in 0.15:
910
# invoked whenever the revision history has been set
911
# with set_revision_history. The api signature is
912
# (branch, revision_history), and the branch will
915
# invoked after a push operation completes.
916
# the api signature is
918
# containing the members
919
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
920
# where local is the local branch or None, master is the target
921
# master branch, and the rest should be self explanatory. The source
922
# is read locked and the target branches write locked. Source will
923
# be the local low-latency branch.
924
self['post_push'] = []
925
# invoked after a pull operation completes.
926
# the api signature is
928
# containing the members
929
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
930
# where local is the local branch or None, master is the target
931
# master branch, and the rest should be self explanatory. The source
932
# is read locked and the target branches write locked. The local
933
# branch is the low-latency branch.
934
self['post_pull'] = []
935
# invoked after a commit operation completes.
936
# the api signature is
937
# (local, master, old_revno, old_revid, new_revno, new_revid)
938
# old_revid is NULL_REVISION for the first commit to a branch.
939
self['post_commit'] = []
940
# invoked after a uncommit operation completes.
941
# the api signature is
942
# (local, master, old_revno, old_revid, new_revno, new_revid) where
943
# local is the local branch or None, master is the target branch,
944
# and an empty branch recieves new_revno of 0, new_revid of None.
945
self['post_uncommit'] = []
947
def install_hook(self, hook_name, a_callable):
948
"""Install a_callable in to the hook hook_name.
950
:param hook_name: A hook name. See the __init__ method of BranchHooks
951
for the complete list of hooks.
952
:param a_callable: The callable to be invoked when the hook triggers.
953
The exact signature will depend on the hook - see the __init__
954
method of BranchHooks for details on each hook.
957
self[hook_name].append(a_callable)
959
raise errors.UnknownHook('branch', hook_name)
962
# install the default hooks into the Branch class.
963
Branch.hooks = BranchHooks()
966
class BzrBranchFormat4(BranchFormat):
967
"""Bzr branch format 4.
970
- a revision-history file.
971
- a branch-lock lock file [ to be shared with the bzrdir ]
974
def get_format_description(self):
975
"""See BranchFormat.get_format_description()."""
976
return "Branch format 4"
978
def initialize(self, a_bzrdir):
979
"""Create a branch of this format in a_bzrdir."""
980
utf8_files = [('revision-history', ''),
983
return self._initialize_helper(a_bzrdir, utf8_files,
984
lock_type='branch4', set_format=False)
987
super(BzrBranchFormat4, self).__init__()
988
self._matchingbzrdir = bzrdir.BzrDirFormat6()
990
def open(self, a_bzrdir, _found=False):
991
"""Return the branch object for a_bzrdir
993
_found is a private parameter, do not use it. It is used to indicate
994
if format probing has already be done.
997
# we are being called directly and must probe.
998
raise NotImplementedError
999
return BzrBranch(_format=self,
1000
_control_files=a_bzrdir._control_files,
1002
_repository=a_bzrdir.open_repository())
1005
return "Bazaar-NG branch format 4"
1008
class BzrBranchFormat5(BranchFormat):
1009
"""Bzr branch format 5.
1012
- a revision-history file.
1014
- a lock dir guarding the branch itself
1015
- all of this stored in a branch/ subdirectory
1016
- works with shared repositories.
1018
This format is new in bzr 0.8.
1021
def get_format_string(self):
1022
"""See BranchFormat.get_format_string()."""
1023
return "Bazaar-NG branch format 5\n"
1025
def get_format_description(self):
1026
"""See BranchFormat.get_format_description()."""
1027
return "Branch format 5"
1029
def initialize(self, a_bzrdir):
1030
"""Create a branch of this format in a_bzrdir."""
1031
utf8_files = [('revision-history', ''),
1032
('branch-name', ''),
1034
return self._initialize_helper(a_bzrdir, utf8_files)
1037
super(BzrBranchFormat5, self).__init__()
1038
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1040
def open(self, a_bzrdir, _found=False):
1041
"""Return the branch object for a_bzrdir
1043
_found is a private parameter, do not use it. It is used to indicate
1044
if format probing has already be done.
1047
format = BranchFormat.find_format(a_bzrdir)
1048
assert format.__class__ == self.__class__
1049
transport = a_bzrdir.get_branch_transport(None)
1050
control_files = lockable_files.LockableFiles(transport, 'lock',
1052
return BzrBranch5(_format=self,
1053
_control_files=control_files,
1055
_repository=a_bzrdir.find_repository())
1058
class BzrBranchFormat6(BzrBranchFormat5):
1059
"""Branch format with last-revision
1061
Unlike previous formats, this has no explicit revision history. Instead,
1062
this just stores the last-revision, and the left-hand history leading
1063
up to there is the history.
1065
This format was introduced in bzr 0.15
1068
def get_format_string(self):
1069
"""See BranchFormat.get_format_string()."""
1070
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1072
def get_format_description(self):
1073
"""See BranchFormat.get_format_description()."""
1074
return "Branch format 6"
1076
def initialize(self, a_bzrdir):
1077
"""Create a branch of this format in a_bzrdir."""
1078
utf8_files = [('last-revision', '0 null:\n'),
1079
('branch-name', ''),
1080
('branch.conf', ''),
1083
return self._initialize_helper(a_bzrdir, utf8_files)
1085
def open(self, a_bzrdir, _found=False):
1086
"""Return the branch object for a_bzrdir
1088
_found is a private parameter, do not use it. It is used to indicate
1089
if format probing has already be done.
1092
format = BranchFormat.find_format(a_bzrdir)
1093
assert format.__class__ == self.__class__
1094
transport = a_bzrdir.get_branch_transport(None)
1095
control_files = lockable_files.LockableFiles(transport, 'lock',
1097
return BzrBranch6(_format=self,
1098
_control_files=control_files,
1100
_repository=a_bzrdir.find_repository())
1102
def supports_tags(self):
1106
class BranchReferenceFormat(BranchFormat):
1107
"""Bzr branch reference format.
1109
Branch references are used in implementing checkouts, they
1110
act as an alias to the real branch which is at some other url.
1117
def get_format_string(self):
1118
"""See BranchFormat.get_format_string()."""
1119
return "Bazaar-NG Branch Reference Format 1\n"
1121
def get_format_description(self):
1122
"""See BranchFormat.get_format_description()."""
1123
return "Checkout reference format 1"
1125
def initialize(self, a_bzrdir, target_branch=None):
1126
"""Create a branch of this format in a_bzrdir."""
1127
if target_branch is None:
1128
# this format does not implement branch itself, thus the implicit
1129
# creation contract must see it as uninitializable
1130
raise errors.UninitializableFormat(self)
1131
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1132
branch_transport = a_bzrdir.get_branch_transport(self)
1133
branch_transport.put_bytes('location',
1134
target_branch.bzrdir.root_transport.base)
1135
branch_transport.put_bytes('format', self.get_format_string())
1136
return self.open(a_bzrdir, _found=True)
1139
super(BranchReferenceFormat, self).__init__()
1140
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1142
def _make_reference_clone_function(format, a_branch):
1143
"""Create a clone() routine for a branch dynamically."""
1144
def clone(to_bzrdir, revision_id=None):
1145
"""See Branch.clone()."""
1146
return format.initialize(to_bzrdir, a_branch)
1147
# cannot obey revision_id limits when cloning a reference ...
1148
# FIXME RBC 20060210 either nuke revision_id for clone, or
1149
# emit some sort of warning/error to the caller ?!
1152
def open(self, a_bzrdir, _found=False):
1153
"""Return the branch that the branch reference in a_bzrdir points at.
1155
_found is a private parameter, do not use it. It is used to indicate
1156
if format probing has already be done.
1159
format = BranchFormat.find_format(a_bzrdir)
1160
assert format.__class__ == self.__class__
1161
transport = a_bzrdir.get_branch_transport(None)
1162
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1163
result = real_bzrdir.open_branch()
1164
# this changes the behaviour of result.clone to create a new reference
1165
# rather than a copy of the content of the branch.
1166
# I did not use a proxy object because that needs much more extensive
1167
# testing, and we are only changing one behaviour at the moment.
1168
# If we decide to alter more behaviours - i.e. the implicit nickname
1169
# then this should be refactored to introduce a tested proxy branch
1170
# and a subclass of that for use in overriding clone() and ....
1172
result.clone = self._make_reference_clone_function(result)
1176
# formats which have no format string are not discoverable
1177
# and not independently creatable, so are not registered.
1178
__default_format = BzrBranchFormat5()
1179
BranchFormat.register_format(__default_format)
1180
BranchFormat.register_format(BranchReferenceFormat())
1181
BranchFormat.register_format(BzrBranchFormat6())
1182
BranchFormat.set_default_format(__default_format)
1183
_legacy_formats = [BzrBranchFormat4(),
1186
class BzrBranch(Branch):
1187
"""A branch stored in the actual filesystem.
1189
Note that it's "local" in the context of the filesystem; it doesn't
1190
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1191
it's writable, and can be accessed via the normal filesystem API.
1194
def __init__(self, _format=None,
1195
_control_files=None, a_bzrdir=None, _repository=None):
1196
"""Create new branch object at a particular location."""
1197
Branch.__init__(self)
1198
if a_bzrdir is None:
1199
raise ValueError('a_bzrdir must be supplied')
1201
self.bzrdir = a_bzrdir
1202
# self._transport used to point to the directory containing the
1203
# control directory, but was not used - now it's just the transport
1204
# for the branch control files. mbp 20070212
1205
self._base = self.bzrdir.transport.clone('..').base
1206
self._format = _format
1207
if _control_files is None:
1208
raise ValueError('BzrBranch _control_files is None')
1209
self.control_files = _control_files
1210
self._transport = _control_files._transport
1211
self.repository = _repository
1214
return '%s(%r)' % (self.__class__.__name__, self.base)
1218
def _get_base(self):
1219
"""Returns the directory containing the control directory."""
1222
base = property(_get_base, doc="The URL for the root of this branch.")
1224
def abspath(self, name):
1225
"""See Branch.abspath."""
1226
return self.control_files._transport.abspath(name)
1229
@deprecated_method(zero_sixteen)
1231
def get_root_id(self):
1232
"""See Branch.get_root_id."""
1233
tree = self.repository.revision_tree(self.last_revision())
1234
return tree.inventory.root.file_id
1236
def is_locked(self):
1237
return self.control_files.is_locked()
1239
def lock_write(self):
1240
self.repository.lock_write()
1242
self.control_files.lock_write()
1244
self.repository.unlock()
1247
def lock_read(self):
1248
self.repository.lock_read()
1250
self.control_files.lock_read()
1252
self.repository.unlock()
1256
# TODO: test for failed two phase locks. This is known broken.
1258
self.control_files.unlock()
1260
self.repository.unlock()
1261
if not self.control_files.is_locked():
1262
# we just released the lock
1263
self._clear_cached_state()
1265
def peek_lock_mode(self):
1266
if self.control_files._lock_count == 0:
1269
return self.control_files._lock_mode
1271
def get_physical_lock_status(self):
1272
return self.control_files.get_physical_lock_status()
1275
def print_file(self, file, revision_id):
1276
"""See Branch.print_file."""
1277
return self.repository.print_file(file, revision_id)
1280
def append_revision(self, *revision_ids):
1281
"""See Branch.append_revision."""
1282
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1283
for revision_id in revision_ids:
1284
_mod_revision.check_not_reserved_id(revision_id)
1285
mutter("add {%s} to revision-history" % revision_id)
1286
rev_history = self.revision_history()
1287
rev_history.extend(revision_ids)
1288
self.set_revision_history(rev_history)
1290
def _write_revision_history(self, history):
1291
"""Factored out of set_revision_history.
1293
This performs the actual writing to disk.
1294
It is intended to be called by BzrBranch5.set_revision_history."""
1295
self.control_files.put_bytes(
1296
'revision-history', '\n'.join(history))
1299
def set_revision_history(self, rev_history):
1300
"""See Branch.set_revision_history."""
1301
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1302
self._write_revision_history(rev_history)
1303
self._cache_revision_history(rev_history)
1304
for hook in Branch.hooks['set_rh']:
1305
hook(self, rev_history)
1308
def set_last_revision_info(self, revno, revision_id):
1309
revision_id = osutils.safe_revision_id(revision_id)
1310
history = self._lefthand_history(revision_id)
1311
assert len(history) == revno, '%d != %d' % (len(history), revno)
1312
self.set_revision_history(history)
1314
def _gen_revision_history(self):
1315
history = self.control_files.get('revision-history').read().split('\n')
1316
if history[-1:] == ['']:
1317
# There shouldn't be a trailing newline, but just in case.
1321
def _lefthand_history(self, revision_id, last_rev=None,
1323
# stop_revision must be a descendant of last_revision
1324
stop_graph = self.repository.get_revision_graph(revision_id)
1325
if last_rev is not None and last_rev not in stop_graph:
1326
# our previous tip is not merged into stop_revision
1327
raise errors.DivergedBranches(self, other_branch)
1328
# make a new revision history from the graph
1329
current_rev_id = revision_id
1331
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1332
new_history.append(current_rev_id)
1333
current_rev_id_parents = stop_graph[current_rev_id]
1335
current_rev_id = current_rev_id_parents[0]
1337
current_rev_id = None
1338
new_history.reverse()
1342
def generate_revision_history(self, revision_id, last_rev=None,
1344
"""Create a new revision history that will finish with revision_id.
1346
:param revision_id: the new tip to use.
1347
:param last_rev: The previous last_revision. If not None, then this
1348
must be a ancestory of revision_id, or DivergedBranches is raised.
1349
:param other_branch: The other branch that DivergedBranches should
1350
raise with respect to.
1352
revision_id = osutils.safe_revision_id(revision_id)
1353
self.set_revision_history(self._lefthand_history(revision_id,
1354
last_rev, other_branch))
1357
def update_revisions(self, other, stop_revision=None):
1358
"""See Branch.update_revisions."""
1361
if stop_revision is None:
1362
stop_revision = other.last_revision()
1363
if stop_revision is None:
1364
# if there are no commits, we're done.
1367
stop_revision = osutils.safe_revision_id(stop_revision)
1368
# whats the current last revision, before we fetch [and change it
1370
last_rev = self.last_revision()
1371
# we fetch here regardless of whether we need to so that we pickup
1373
self.fetch(other, stop_revision)
1374
my_ancestry = self.repository.get_ancestry(last_rev)
1375
if stop_revision in my_ancestry:
1376
# last_revision is a descendant of stop_revision
1378
self.generate_revision_history(stop_revision, last_rev=last_rev,
1383
def basis_tree(self):
1384
"""See Branch.basis_tree."""
1385
return self.repository.revision_tree(self.last_revision())
1387
@deprecated_method(zero_eight)
639
1388
def working_tree(self):
640
"""Return a `Tree` for the working copy."""
641
return WorkingTree(self.base, self.read_working_inventory())
644
def basis_tree(self):
645
"""Return `Tree` object for last revision.
647
If there are no revisions yet, return an `EmptyTree`.
649
>>> b = ScratchBranch(files=['foo'])
650
>>> b.basis_tree().has_filename('foo')
652
>>> b.working_tree().has_filename('foo')
655
>>> b.commit('add foo')
656
>>> b.basis_tree().has_filename('foo')
659
r = self.last_patch()
1389
"""Create a Working tree object for this branch."""
1391
from bzrlib.transport.local import LocalTransport
1392
if (self.base.find('://') != -1 or
1393
not isinstance(self._transport, LocalTransport)):
1394
raise NoWorkingTree(self.base)
1395
return self.bzrdir.open_workingtree()
1398
def pull(self, source, overwrite=False, stop_revision=None,
1399
_hook_master=None, _run_hooks=True):
1402
:param _hook_master: Private parameter - set the branch to
1403
be supplied as the master to push hooks.
1404
:param _run_hooks: Private parameter - allow disabling of
1405
hooks, used when pushing to a master branch.
1407
result = PullResult()
1408
result.source_branch = source
1409
result.target_branch = self
1412
result.old_revno, result.old_revid = self.last_revision_info()
1414
self.update_revisions(source, stop_revision)
1415
except DivergedBranches:
1419
if stop_revision is None:
1420
stop_revision = source.last_revision()
1421
self.generate_revision_history(stop_revision)
1422
result.tag_conflicts = source.tags.merge_to(self.tags)
1423
result.new_revno, result.new_revid = self.last_revision_info()
1425
result.master_branch = _hook_master
1426
result.local_branch = self
1428
result.master_branch = self
1429
result.local_branch = None
1431
for hook in Branch.hooks['post_pull']:
1437
def _get_parent_location(self):
1438
_locs = ['parent', 'pull', 'x-pull']
1441
return self.control_files.get(l).read().strip('\n')
1447
def push(self, target, overwrite=False, stop_revision=None,
1448
_hook_master=None, _run_hooks=True):
1451
:param _hook_master: Private parameter - set the branch to
1452
be supplied as the master to push hooks.
1453
:param _run_hooks: Private parameter - allow disabling of
1454
hooks, used when pushing to a master branch.
1456
result = PushResult()
1457
result.source_branch = self
1458
result.target_branch = target
1461
result.old_revno, result.old_revid = target.last_revision_info()
1463
target.update_revisions(self, stop_revision)
1464
except DivergedBranches:
1468
target.set_revision_history(self.revision_history())
1469
result.tag_conflicts = self.tags.merge_to(target.tags)
1470
result.new_revno, result.new_revid = target.last_revision_info()
1472
result.master_branch = _hook_master
1473
result.local_branch = target
1475
result.master_branch = target
1476
result.local_branch = None
1478
for hook in Branch.hooks['post_push']:
1484
def get_parent(self):
1485
"""See Branch.get_parent."""
1487
assert self.base[-1] == '/'
1488
parent = self._get_parent_location()
1491
# This is an old-format absolute path to a local branch
1492
# turn it into a url
1493
if parent.startswith('/'):
1494
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1496
return urlutils.join(self.base[:-1], parent)
1497
except errors.InvalidURLJoin, e:
1498
raise errors.InaccessibleParent(parent, self.base)
1500
def get_push_location(self):
1501
"""See Branch.get_push_location."""
1502
push_loc = self.get_config().get_user_option('push_location')
1505
def set_push_location(self, location):
1506
"""See Branch.set_push_location."""
1507
self.get_config().set_user_option(
1508
'push_location', location,
1509
store=_mod_config.STORE_LOCATION_NORECURSE)
1512
def set_parent(self, url):
1513
"""See Branch.set_parent."""
1514
# TODO: Maybe delete old location files?
1515
# URLs should never be unicode, even on the local fs,
1516
# FIXUP this and get_parent in a future branch format bump:
1517
# read and rewrite the file, and have the new format code read
1518
# using .get not .get_utf8. RBC 20060125
1520
if isinstance(url, unicode):
1522
url = url.encode('ascii')
1523
except UnicodeEncodeError:
1524
raise bzrlib.errors.InvalidURL(url,
1525
"Urls must be 7-bit ascii, "
1526
"use bzrlib.urlutils.escape")
1527
url = urlutils.relative_url(self.base, url)
1528
self._set_parent_location(url)
1530
def _set_parent_location(self, url):
1532
self.control_files._transport.delete('parent')
663
return RevisionTree(self.text_store, self.get_revision_inventory(r))
667
def write_log(self, show_timezone='original'):
668
"""Write out human-readable log of commits to this branch
670
:param utc: If true, show dates in universal time, not local time."""
671
## TODO: Option to choose either original, utc or local timezone
674
for p in self.revision_history():
676
print 'revno:', revno
677
## TODO: Show hash if --id is given.
678
##print 'revision-hash:', p
679
rev = self.get_revision(p)
680
print 'committer:', rev.committer
681
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
684
## opportunistic consistency check, same as check_patch_chaining
685
if rev.precursor != precursor:
686
bailout("mismatched precursor!")
690
print ' (no message)'
692
for l in rev.message.split('\n'):
700
def show_status(branch, show_all=False):
701
"""Display single-line status for non-ignored working files.
703
The list is show sorted in order by file name.
705
>>> b = ScratchBranch(files=['foo', 'foo~'])
711
>>> b.commit("add foo")
713
>>> os.unlink(b.abspath('foo'))
718
:todo: Get state for single files.
720
:todo: Perhaps show a slash at the end of directory names.
724
# We have to build everything into a list first so that it can
725
# sorted by name, incorporating all the different sources.
727
# FIXME: Rather than getting things in random order and then sorting,
728
# just step through in order.
730
# Interesting case: the old ID for a file has been removed,
731
# but a new file has been created under that name.
733
old = branch.basis_tree()
734
old_inv = old.inventory
735
new = branch.working_tree()
736
new_inv = new.inventory
738
for fs, fid, oldname, newname, kind in diff_trees(old, new):
740
show_status(fs, kind,
741
oldname + ' => ' + newname)
742
elif fs == 'A' or fs == 'M':
743
show_status(fs, kind, newname)
745
show_status(fs, kind, oldname)
748
show_status(fs, kind, newname)
751
show_status(fs, kind, newname)
753
show_status(fs, kind, newname)
755
bailout("wierd file state %r" % ((fs, fid),))
759
class ScratchBranch(Branch):
760
"""Special test class: a branch that cleans up after itself.
762
>>> b = ScratchBranch()
1534
assert isinstance(url, str)
1535
self.control_files.put_bytes('parent', url + '\n')
1537
@deprecated_function(zero_nine)
1538
def tree_config(self):
1539
"""DEPRECATED; call get_config instead.
1540
TreeConfig has become part of BranchConfig."""
1541
return TreeConfig(self)
1544
class BzrBranch5(BzrBranch):
1545
"""A format 5 branch. This supports new features over plan branches.
1547
It has support for a master_branch which is the data for bound branches.
770
def __init__(self, files=[], dirs=[]):
771
"""Make a test branch.
773
This creates a temporary directory and runs init-tree in it.
775
If any files are listed, they are created in the working copy.
777
Branch.__init__(self, tempfile.mkdtemp(), init=True)
779
os.mkdir(self.abspath(d))
782
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
786
"""Destroy the test branch, removing the scratch directory."""
787
shutil.rmtree(self.base)
791
######################################################################
795
def is_control_file(filename):
796
## FIXME: better check
797
filename = os.path.normpath(filename)
798
while filename != '':
799
head, tail = os.path.split(filename)
800
## mutter('check %r for control file' % ((head, tail), ))
801
if tail == bzrlib.BZRDIR:
1555
super(BzrBranch5, self).__init__(_format=_format,
1556
_control_files=_control_files,
1558
_repository=_repository)
1561
def pull(self, source, overwrite=False, stop_revision=None,
1563
"""Extends branch.pull to be bound branch aware.
1565
:param _run_hooks: Private parameter used to force hook running
1566
off during bound branch double-pushing.
1568
bound_location = self.get_bound_location()
1569
master_branch = None
1570
if bound_location and source.base != bound_location:
1571
# not pulling from master, so we need to update master.
1572
master_branch = self.get_master_branch()
1573
master_branch.lock_write()
1576
# pull from source into master.
1577
master_branch.pull(source, overwrite, stop_revision,
1579
return super(BzrBranch5, self).pull(source, overwrite,
1580
stop_revision, _hook_master=master_branch,
1581
_run_hooks=_run_hooks)
1584
master_branch.unlock()
1587
def push(self, target, overwrite=False, stop_revision=None):
1588
"""Updates branch.push to be bound branch aware."""
1589
bound_location = target.get_bound_location()
1590
master_branch = None
1591
if bound_location and target.base != bound_location:
1592
# not pushing to master, so we need to update master.
1593
master_branch = target.get_master_branch()
1594
master_branch.lock_write()
1597
# push into the master from this branch.
1598
super(BzrBranch5, self).push(master_branch, overwrite,
1599
stop_revision, _run_hooks=False)
1600
# and push into the target branch from this. Note that we push from
1601
# this branch again, because its considered the highest bandwidth
1603
return super(BzrBranch5, self).push(target, overwrite,
1604
stop_revision, _hook_master=master_branch)
1607
master_branch.unlock()
1609
def get_bound_location(self):
1611
return self.control_files.get_utf8('bound').read()[:-1]
1612
except errors.NoSuchFile:
1616
def get_master_branch(self):
1617
"""Return the branch we are bound to.
1619
:return: Either a Branch, or None
1621
This could memoise the branch, but if thats done
1622
it must be revalidated on each new lock.
1623
So for now we just don't memoise it.
1624
# RBC 20060304 review this decision.
1626
bound_loc = self.get_bound_location()
1630
return Branch.open(bound_loc)
1631
except (errors.NotBranchError, errors.ConnectionError), e:
1632
raise errors.BoundBranchConnectionFailure(
1636
def set_bound_location(self, location):
1637
"""Set the target where this branch is bound to.
1639
:param location: URL to the target branch
1642
self.control_files.put_utf8('bound', location+'\n')
1645
self.control_files._transport.delete('bound')
810
def _gen_revision_id(when):
811
"""Return new revision-id."""
812
s = '%s-%s-' % (user_email(), compact_date(when))
813
s += hexlify(rand_bytes(8))
817
def gen_file_id(name):
818
"""Return new file id.
820
This should probably generate proper UUIDs, but for the moment we
821
cope with just randomness because running uuidgen every time is
823
idx = name.rfind('/')
825
name = name[idx+1 : ]
827
name = name.lstrip('.')
829
s = hexlify(rand_bytes(8))
830
return '-'.join((name, compact_date(time.time()), s))
1651
def bind(self, other):
1652
"""Bind this branch to the branch other.
1654
This does not push or pull data between the branches, though it does
1655
check for divergence to raise an error when the branches are not
1656
either the same, or one a prefix of the other. That behaviour may not
1657
be useful, so that check may be removed in future.
1659
:param other: The branch to bind to
1662
# TODO: jam 20051230 Consider checking if the target is bound
1663
# It is debatable whether you should be able to bind to
1664
# a branch which is itself bound.
1665
# Committing is obviously forbidden,
1666
# but binding itself may not be.
1667
# Since we *have* to check at commit time, we don't
1668
# *need* to check here
1670
# we want to raise diverged if:
1671
# last_rev is not in the other_last_rev history, AND
1672
# other_last_rev is not in our history, and do it without pulling
1674
last_rev = self.last_revision()
1675
if last_rev is not None:
1678
other_last_rev = other.last_revision()
1679
if other_last_rev is not None:
1680
# neither branch is new, we have to do some work to
1681
# ascertain diversion.
1682
remote_graph = other.repository.get_revision_graph(
1684
local_graph = self.repository.get_revision_graph(last_rev)
1685
if (last_rev not in remote_graph and
1686
other_last_rev not in local_graph):
1687
raise errors.DivergedBranches(self, other)
1690
self.set_bound_location(other.base)
1694
"""If bound, unbind"""
1695
return self.set_bound_location(None)
1699
"""Synchronise this branch with the master branch if any.
1701
:return: None or the last_revision that was pivoted out during the
1704
master = self.get_master_branch()
1705
if master is not None:
1706
old_tip = self.last_revision()
1707
self.pull(master, overwrite=True)
1708
if old_tip in self.repository.get_ancestry(self.last_revision()):
1714
class BzrBranchExperimental(BzrBranch5):
1715
"""Bzr experimental branch format
1718
- a revision-history file.
1720
- a lock dir guarding the branch itself
1721
- all of this stored in a branch/ subdirectory
1722
- works with shared repositories.
1723
- a tag dictionary in the branch
1725
This format is new in bzr 0.15, but shouldn't be used for real data,
1728
This class acts as it's own BranchFormat.
1731
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1734
def get_format_string(cls):
1735
"""See BranchFormat.get_format_string()."""
1736
return "Bazaar-NG branch format experimental\n"
1739
def get_format_description(cls):
1740
"""See BranchFormat.get_format_description()."""
1741
return "Experimental branch format"
1744
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1746
branch_transport = a_bzrdir.get_branch_transport(cls)
1747
control_files = lockable_files.LockableFiles(branch_transport,
1748
lock_filename, lock_class)
1749
control_files.create_lock()
1750
control_files.lock_write()
1752
for filename, content in utf8_files:
1753
control_files.put_utf8(filename, content)
1755
control_files.unlock()
1758
def initialize(cls, a_bzrdir):
1759
"""Create a branch of this format in a_bzrdir."""
1760
utf8_files = [('format', cls.get_format_string()),
1761
('revision-history', ''),
1762
('branch-name', ''),
1765
cls._initialize_control_files(a_bzrdir, utf8_files,
1766
'lock', lockdir.LockDir)
1767
return cls.open(a_bzrdir, _found=True)
1770
def open(cls, a_bzrdir, _found=False):
1771
"""Return the branch object for a_bzrdir
1773
_found is a private parameter, do not use it. It is used to indicate
1774
if format probing has already be done.
1777
format = BranchFormat.find_format(a_bzrdir)
1778
assert format.__class__ == cls
1779
transport = a_bzrdir.get_branch_transport(None)
1780
control_files = lockable_files.LockableFiles(transport, 'lock',
1782
return cls(_format=cls,
1783
_control_files=control_files,
1785
_repository=a_bzrdir.find_repository())
1788
def is_supported(cls):
1791
def _make_tags(self):
1792
return BasicTags(self)
1795
def supports_tags(cls):
1799
BranchFormat.register_format(BzrBranchExperimental)
1802
class BzrBranch6(BzrBranch5):
1805
def last_revision_info(self):
1806
revision_string = self.control_files.get('last-revision').read()
1807
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1808
revision_id = cache_utf8.get_cached_utf8(revision_id)
1810
return revno, revision_id
1812
def last_revision(self):
1813
"""Return last revision id, or None"""
1814
revision_id = self.last_revision_info()[1]
1815
if revision_id == _mod_revision.NULL_REVISION:
1819
def _write_last_revision_info(self, revno, revision_id):
1820
"""Simply write out the revision id, with no checks.
1822
Use set_last_revision_info to perform this safely.
1824
Does not update the revision_history cache.
1825
Intended to be called by set_last_revision_info and
1826
_write_revision_history.
1828
if revision_id is None:
1829
revision_id = 'null:'
1830
out_string = '%d %s\n' % (revno, revision_id)
1831
self.control_files.put_bytes('last-revision', out_string)
1834
def set_last_revision_info(self, revno, revision_id):
1835
revision_id = osutils.safe_revision_id(revision_id)
1836
if self._get_append_revisions_only():
1837
self._check_history_violation(revision_id)
1838
self._write_last_revision_info(revno, revision_id)
1839
self._clear_cached_state()
1841
def _check_history_violation(self, revision_id):
1842
last_revision = self.last_revision()
1843
if last_revision is None:
1845
if last_revision not in self._lefthand_history(revision_id):
1846
raise errors.AppendRevisionsOnlyViolation(self.base)
1848
def _gen_revision_history(self):
1849
"""Generate the revision history from last revision
1851
history = list(self.repository.iter_reverse_revision_history(
1852
self.last_revision()))
1856
def _write_revision_history(self, history):
1857
"""Factored out of set_revision_history.
1859
This performs the actual writing to disk, with format-specific checks.
1860
It is intended to be called by BzrBranch5.set_revision_history.
1862
if len(history) == 0:
1863
last_revision = 'null:'
1865
if history != self._lefthand_history(history[-1]):
1866
raise errors.NotLefthandHistory(history)
1867
last_revision = history[-1]
1868
if self._get_append_revisions_only():
1869
self._check_history_violation(last_revision)
1870
self._write_last_revision_info(len(history), last_revision)
1873
def append_revision(self, *revision_ids):
1874
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1875
if len(revision_ids) == 0:
1877
prev_revno, prev_revision = self.last_revision_info()
1878
for revision in self.repository.get_revisions(revision_ids):
1879
if prev_revision == _mod_revision.NULL_REVISION:
1880
if revision.parent_ids != []:
1881
raise errors.NotLeftParentDescendant(self, prev_revision,
1882
revision.revision_id)
1884
if revision.parent_ids[0] != prev_revision:
1885
raise errors.NotLeftParentDescendant(self, prev_revision,
1886
revision.revision_id)
1887
prev_revision = revision.revision_id
1888
self.set_last_revision_info(prev_revno + len(revision_ids),
1892
def _set_parent_location(self, url):
1893
"""Set the parent branch"""
1894
self._set_config_location('parent_location', url, make_relative=True)
1897
def _get_parent_location(self):
1898
"""Set the parent branch"""
1899
return self._get_config_location('parent_location')
1901
def set_push_location(self, location):
1902
"""See Branch.set_push_location."""
1903
self._set_config_location('push_location', location)
1905
def set_bound_location(self, location):
1906
"""See Branch.set_push_location."""
1908
config = self.get_config()
1909
if location is None:
1910
if config.get_user_option('bound') != 'True':
1913
config.set_user_option('bound', 'False')
1916
self._set_config_location('bound_location', location,
1918
config.set_user_option('bound', 'True')
1921
def _get_bound_location(self, bound):
1922
"""Return the bound location in the config file.
1924
Return None if the bound parameter does not match"""
1925
config = self.get_config()
1926
config_bound = (config.get_user_option('bound') == 'True')
1927
if config_bound != bound:
1929
return self._get_config_location('bound_location', config=config)
1931
def get_bound_location(self):
1932
"""See Branch.set_push_location."""
1933
return self._get_bound_location(True)
1935
def get_old_bound_location(self):
1936
"""See Branch.get_old_bound_location"""
1937
return self._get_bound_location(False)
1939
def set_append_revisions_only(self, enabled):
1944
self.get_config().set_user_option('append_revisions_only', value)
1946
def _get_append_revisions_only(self):
1947
value = self.get_config().get_user_option('append_revisions_only')
1948
return value == 'True'
1950
def _synchronize_history(self, destination, revision_id):
1951
"""Synchronize last revision and revision history between branches.
1953
This version is most efficient when the destination is also a
1954
BzrBranch6, but works for BzrBranch5, as long as the destination's
1955
repository contains all the lefthand ancestors of the intended
1956
last_revision. If not, set_last_revision_info will fail.
1958
:param destination: The branch to copy the history into
1959
:param revision_id: The revision-id to truncate history at. May
1960
be None to copy complete history.
1962
if revision_id is None:
1963
revno, revision_id = self.last_revision_info()
1965
revno = self.revision_id_to_revno(revision_id)
1966
destination.set_last_revision_info(revno, revision_id)
1968
def _make_tags(self):
1969
return BasicTags(self)
1972
class BranchTestProviderAdapter(object):
1973
"""A tool to generate a suite testing multiple branch formats at once.
1975
This is done by copying the test once for each transport and injecting
1976
the transport_server, transport_readonly_server, and branch_format
1977
classes into each copy. Each copy is also given a new id() to make it
1981
def __init__(self, transport_server, transport_readonly_server, formats):
1982
self._transport_server = transport_server
1983
self._transport_readonly_server = transport_readonly_server
1984
self._formats = formats
1986
def adapt(self, test):
1987
result = TestSuite()
1988
for branch_format, bzrdir_format in self._formats:
1989
new_test = deepcopy(test)
1990
new_test.transport_server = self._transport_server
1991
new_test.transport_readonly_server = self._transport_readonly_server
1992
new_test.bzrdir_format = bzrdir_format
1993
new_test.branch_format = branch_format
1994
def make_new_test_id():
1995
# the format can be either a class or an instance
1996
name = getattr(branch_format, '__name__',
1997
branch_format.__class__.__name__)
1998
new_id = "%s(%s)" % (new_test.id(), name)
1999
return lambda: new_id
2000
new_test.id = make_new_test_id()
2001
result.addTest(new_test)
2005
######################################################################
2006
# results of operations
2009
class _Result(object):
2011
def _show_tag_conficts(self, to_file):
2012
if not getattr(self, 'tag_conflicts', None):
2014
to_file.write('Conflicting tags:\n')
2015
for name, value1, value2 in self.tag_conflicts:
2016
to_file.write(' %s\n' % (name, ))
2019
class PullResult(_Result):
2020
"""Result of a Branch.pull operation.
2022
:ivar old_revno: Revision number before pull.
2023
:ivar new_revno: Revision number after pull.
2024
:ivar old_revid: Tip revision id before pull.
2025
:ivar new_revid: Tip revision id after pull.
2026
:ivar source_branch: Source (local) branch object.
2027
:ivar master_branch: Master branch of the target, or None.
2028
:ivar target_branch: Target/destination branch object.
2032
# DEPRECATED: pull used to return the change in revno
2033
return self.new_revno - self.old_revno
2035
def report(self, to_file):
2036
if self.old_revid == self.new_revid:
2037
to_file.write('No revisions to pull.\n')
2039
to_file.write('Now on revision %d.\n' % self.new_revno)
2040
self._show_tag_conficts(to_file)
2043
class PushResult(_Result):
2044
"""Result of a Branch.push operation.
2046
:ivar old_revno: Revision number before push.
2047
:ivar new_revno: Revision number after push.
2048
:ivar old_revid: Tip revision id before push.
2049
:ivar new_revid: Tip revision id after push.
2050
:ivar source_branch: Source branch object.
2051
:ivar master_branch: Master branch of the target, or None.
2052
:ivar target_branch: Target/destination branch object.
2056
# DEPRECATED: push used to return the change in revno
2057
return self.new_revno - self.old_revno
2059
def report(self, to_file):
2060
"""Write a human-readable description of the result."""
2061
if self.old_revid == self.new_revid:
2062
to_file.write('No new revisions to push.\n')
2064
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2065
self._show_tag_conficts(to_file)
2068
class BranchCheckResult(object):
2069
"""Results of checking branch consistency.
2074
def __init__(self, branch):
2075
self.branch = branch
2077
def report_results(self, verbose):
2078
"""Report the check results via trace.note.
2080
:param verbose: Requests more detailed display of what was checked,
2083
note('checked branch %s format %s',
2085
self.branch._format)
2088
class Converter5to6(object):
2089
"""Perform an in-place upgrade of format 5 to format 6"""
2091
def convert(self, branch):
2092
# Data for 5 and 6 can peacefully coexist.
2093
format = BzrBranchFormat6()
2094
new_branch = format.open(branch.bzrdir, _found=True)
2096
# Copy source data into target
2097
new_branch.set_last_revision_info(*branch.last_revision_info())
2098
new_branch.set_parent(branch.get_parent())
2099
new_branch.set_bound_location(branch.get_bound_location())
2100
new_branch.set_push_location(branch.get_push_location())
2102
# New branch has no tags by default
2103
new_branch.tags._set_tag_dict({})
2105
# Copying done; now update target format
2106
new_branch.control_files.put_utf8('format',
2107
format.get_format_string())
2109
# Clean up old files
2110
new_branch.control_files._transport.delete('revision-history')
2112
branch.set_parent(None)
2115
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
