1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 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
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
18
from copy import deepcopy
19
from cStringIO import StringIO
20
from unittest import TestSuite
21
from warnings import warn
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
38
## TODO: Maybe include checks for common corruption of newlines, etc?
42
def find_branch(f, **args):
43
if f and (f.startswith('http://') or f.startswith('https://')):
45
return remotebranch.RemoteBranch(f, **args)
47
return Branch(f, **args)
50
def find_branch_root(f=None):
51
"""Find the branch root enclosing f, or pwd.
53
f may be a filename or a URL.
55
It is not necessary that f exists.
57
Basically we keep looking up until we find the control directory or
61
elif hasattr(os.path, 'realpath'):
62
f = os.path.realpath(f)
64
f = os.path.abspath(f)
65
if not os.path.exists(f):
66
raise BzrError('%r does not exist' % f)
72
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
74
head, tail = os.path.split(f)
76
# reached the root, whatever that may be
77
raise BzrError('%r is not in a branch' % orig_f)
24
from bzrlib import bzrdir, errors, lockdir, osutils, revision, \
28
from bzrlib.config import TreeConfig
29
from bzrlib.decorators import needs_read_lock, needs_write_lock
30
import bzrlib.errors as errors
31
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
32
HistoryMissing, InvalidRevisionId,
33
InvalidRevisionNumber, LockError, NoSuchFile,
34
NoSuchRevision, NoWorkingTree, NotVersionedError,
35
NotBranchError, UninitializableFormat,
36
UnlistableStore, UnlistableBranch,
38
from bzrlib.lockable_files import LockableFiles, TransportLock
39
from bzrlib.symbol_versioning import (deprecated_function,
43
zero_eight, zero_nine,
45
from bzrlib.trace import mutter, note
48
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
49
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
50
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
53
# TODO: Maybe include checks for common corruption of newlines, etc?
55
# TODO: Some operations like log might retrieve the same revisions
56
# repeatedly to calculate deltas. We could perhaps have a weakref
57
# cache in memory to make this faster. In general anything can be
58
# cached in memory between lock and unlock operations. .. nb thats
59
# what the transaction identity map provides
82
62
######################################################################
86
66
"""Branch holding a history of revisions.
89
Base directory of the branch.
69
Base directory/url of the branch.
93
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
94
"""Create new branch object at a particular location.
96
base -- Base directory for the branch.
98
init -- If True, create new control files in a previously
99
unversioned directory. If False, the branch must already
102
find_root -- If true and init is false, find the root of the
103
existing branch containing base.
105
In the test suite, creation of new trees is tested using the
106
`ScratchBranch` class.
109
self.base = os.path.realpath(base)
112
self.base = find_branch_root(base)
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 branch rooted at base.
102
For instance, if the branch is at URL/.bzr/branch,
103
Branch.open(URL) -> a Branch 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')
155
def lock_write(self):
156
raise NotImplementedError('lock_write is abstract')
159
raise NotImplementedError('lock_read is abstract')
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')
171
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()
114
self.base = os.path.realpath(base)
115
if not isdir(self.controlfilename('.')):
116
bailout("not a bzr branch: %s" % quotefn(base),
117
['use "bzr init" to initialize a new working tree',
118
'current bzr can only operate from top-of-tree'])
122
self.text_store = ImmutableStore(self.controlfilename('text-store'))
123
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
124
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
128
return '%s(%r)' % (self.__class__.__name__, self.base)
135
def lock(self, mode='w'):
136
"""Lock the on-disk branch, excluding other processes."""
207
from_branch.lock_read()
142
om = os.O_WRONLY | os.O_CREAT
147
raise BzrError("invalid locking mode %r" % mode)
150
lockfile = os.open(self.controlfilename('branch-lock'), om)
152
if e.errno == errno.ENOENT:
153
# might not exist on branches from <0.0.4
154
self.controlfile('branch-lock', 'w').close()
155
lockfile = os.open(self.controlfilename('branch-lock'), om)
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]
159
fcntl.lockf(lockfile, lm)
161
fcntl.lockf(lockfile, fcntl.LOCK_UN)
163
self._lockmode = None
165
self._lockmode = mode
167
warning("please write a locking method for platform %r" % sys.platform)
169
self._lockmode = None
171
self._lockmode = mode
174
def _need_readlock(self):
175
if self._lockmode not in ['r', 'w']:
176
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
178
def _need_writelock(self):
179
if self._lockmode not in ['w']:
180
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
183
def abspath(self, name):
184
"""Return absolute filename for something in the branch"""
185
return os.path.join(self.base, name)
188
def relpath(self, path):
189
"""Return path relative to this branch of something inside it.
191
Raises an error if path is not in this branch."""
192
rp = os.path.realpath(path)
194
if not rp.startswith(self.base):
195
bailout("path %r is not within branch %r" % (rp, self.base))
196
rp = rp[len(self.base):]
197
rp = rp.lstrip(os.sep)
201
def controlfilename(self, file_or_path):
202
"""Return location relative to branch."""
203
if isinstance(file_or_path, types.StringTypes):
204
file_or_path = [file_or_path]
205
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
208
def controlfile(self, file_or_path, mode='r'):
209
"""Open a control file for this branch.
211
There are two classes of file in the control directory: text
212
and binary. binary files are untranslated byte streams. Text
213
control files are stored with Unix newlines and in UTF-8, even
214
if the platform or locale defaults are different.
216
Controlfiles should almost never be opened in write mode but
217
rather should be atomically copied and replaced using atomicfile.
220
fn = self.controlfilename(file_or_path)
222
if mode == 'rb' or mode == 'wb':
223
return file(fn, mode)
224
elif mode == 'r' or mode == 'w':
225
# open in binary mode anyhow so there's no newline translation;
226
# codecs uses line buffering by default; don't want that.
228
return codecs.open(fn, mode + 'b', 'utf-8',
231
raise BzrError("invalid controlfile mode %r" % mode)
235
def _make_control(self):
236
os.mkdir(self.controlfilename([]))
237
self.controlfile('README', 'w').write(
238
"This is a Bazaar-NG control directory.\n"
239
"Do not change any files in this directory.")
240
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
241
for d in ('text-store', 'inventory-store', 'revision-store'):
242
os.mkdir(self.controlfilename(d))
243
for f in ('revision-history', 'merged-patches',
244
'pending-merged-patches', 'branch-name',
246
self.controlfile(f, 'w').write('')
247
mutter('created control directory in ' + self.base)
248
Inventory().write_xml(self.controlfile('inventory','w'))
251
def _check_format(self):
252
"""Check this branch format is supported.
254
The current tool only supports the current unstable format.
256
In the future, we might need different in-memory Branch
257
classes to support downlevel branches. But not yet.
259
# This ignores newlines so that we can open branches created
260
# on Windows from Linux and so on. I think it might be better
261
# to always make all internal files in unix format.
262
fmt = self.controlfile('branch-format', 'r').read()
263
fmt.replace('\r\n', '')
264
if fmt != BZR_BRANCH_FORMAT:
265
bailout('sorry, branch format %r not supported' % fmt,
266
['use a different bzr version',
267
'or remove the .bzr directory and "bzr init" again'])
270
def read_working_inventory(self):
271
"""Read the working inventory."""
272
self._need_readlock()
274
# ElementTree does its own conversion from UTF-8, so open in
276
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
277
mutter("loaded inventory of %d items in %f"
278
% (len(inv), time.time() - before))
282
def _write_inventory(self, inv):
283
"""Update the working inventory.
285
That is to say, the inventory describing changes underway, that
286
will be committed to the next revision.
288
self._need_writelock()
289
## TODO: factor out to atomicfile? is rename safe on windows?
290
## TODO: Maybe some kind of clean/dirty marker on inventory?
291
tmpfname = self.controlfilename('inventory.tmp')
292
tmpf = file(tmpfname, 'wb')
295
inv_fname = self.controlfilename('inventory')
296
if sys.platform == 'win32':
298
os.rename(tmpfname, inv_fname)
299
mutter('wrote working inventory')
302
inventory = property(read_working_inventory, _write_inventory, None,
303
"""Inventory for the working copy.""")
306
def add(self, files, verbose=False):
307
"""Make files versioned.
309
Note that the command line normally calls smart_add instead.
311
This puts the files in the Added state, so that they will be
312
recorded by the next commit.
314
TODO: Perhaps have an option to add the ids even if the files do
317
TODO: Perhaps return the ids of the files? But then again it
318
is easy to retrieve them if they're needed.
320
TODO: Option to specify file id.
322
TODO: Adding a directory should optionally recurse down and
323
add all non-ignored children. Perhaps do that in a
326
self._need_writelock()
328
# TODO: Re-adding a file that is removed in the working copy
329
# should probably put it back with the previous ID.
330
if isinstance(files, types.StringTypes):
333
inv = self.read_working_inventory()
335
if is_control_file(f):
336
bailout("cannot add control file %s" % quotefn(f))
341
bailout("cannot add top-level %r" % f)
343
fullpath = os.path.normpath(self.abspath(f))
346
kind = file_kind(fullpath)
348
# maybe something better?
349
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
351
if kind != 'file' and kind != 'directory':
352
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
354
file_id = gen_file_id(f)
355
inv.add_path(f, kind=kind, file_id=file_id)
358
show_status('A', kind, quotefn(f))
360
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
362
self._write_inventory(inv)
365
def print_file(self, file, revno):
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
260
def get_revision_delta(self, revno):
261
"""Return the delta for one revision.
263
The delta is relative to its mainline predecessor, or the
264
empty tree for revision 1.
266
assert isinstance(revno, int)
267
rh = self.revision_history()
268
if not (1 <= revno <= len(rh)):
269
raise InvalidRevisionNumber(revno)
270
return self.repository.get_revision_delta(rh[revno-1])
272
def get_root_id(self):
273
"""Return the id of this branches root"""
274
raise NotImplementedError('get_root_id is abstract')
276
def print_file(self, file, revision_id):
366
277
"""Print `file` to stdout."""
367
self._need_readlock()
368
tree = self.revision_tree(self.lookup_revision(revno))
369
# use inventory as it was in that revision
370
file_id = tree.inventory.path2id(file)
372
bailout("%r is not present in revision %d" % (file, revno))
373
tree.print_file(file_id)
376
def remove(self, files, verbose=False):
377
"""Mark nominated files for removal from the inventory.
379
This does not remove their text. This does not run on
381
TODO: Refuse to remove modified files unless --force is given?
383
TODO: Do something useful with directories.
385
TODO: Should this remove the text or not? Tough call; not
386
removing may be useful and the user can just use use rm, and
387
is the opposite of add. Removing it is consistent with most
388
other tools. Maybe an option.
390
## TODO: Normalize names
391
## TODO: Remove nested loops; better scalability
392
self._need_writelock()
394
if isinstance(files, types.StringTypes):
397
tree = self.working_tree()
400
# do this before any modifications
404
bailout("cannot remove unversioned file %s" % quotefn(f))
405
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
407
# having remove it, it must be either ignored or unknown
408
if tree.is_ignored(f):
412
show_status(new_status, inv[fid].kind, quotefn(f))
415
self._write_inventory(inv)
419
"""Return all unknown files.
421
These are files in the working directory that are not versioned or
422
control files or ignored.
424
>>> b = ScratchBranch(files=['foo', 'foo~'])
425
>>> list(b.unknowns())
428
>>> list(b.unknowns())
431
>>> list(b.unknowns())
434
return self.working_tree().unknowns()
437
def append_revision(self, revision_id):
438
mutter("add {%s} to revision-history" % revision_id)
439
rev_history = self.revision_history()
441
tmprhname = self.controlfilename('revision-history.tmp')
442
rhname = self.controlfilename('revision-history')
444
f = file(tmprhname, 'wt')
445
rev_history.append(revision_id)
446
f.write('\n'.join(rev_history))
450
if sys.platform == 'win32':
452
os.rename(tmprhname, rhname)
456
def get_revision(self, revision_id):
457
"""Return the Revision object for a named revision"""
458
self._need_readlock()
459
r = Revision.read_xml(self.revision_store[revision_id])
460
assert r.revision_id == revision_id
464
def get_inventory(self, inventory_id):
465
"""Get Inventory object by hash.
467
TODO: Perhaps for this and similar methods, take a revision
468
parameter which can be either an integer revno or a
470
self._need_readlock()
471
i = Inventory.read_xml(self.inventory_store[inventory_id])
475
def get_revision_inventory(self, revision_id):
476
"""Return inventory of a past revision."""
477
self._need_readlock()
478
if revision_id == None:
481
return self.get_inventory(self.get_revision(revision_id).inventory_id)
278
raise NotImplementedError('print_file is abstract')
280
def append_revision(self, *revision_ids):
281
raise NotImplementedError('append_revision is abstract')
283
def set_revision_history(self, rev_history):
284
raise NotImplementedError('set_revision_history is abstract')
484
286
def revision_history(self):
485
"""Return sequence of revision hashes on to this branch.
487
>>> ScratchBranch().revision_history()
490
self._need_readlock()
491
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
494
def enum_history(self, direction):
495
"""Return (revno, revision_id) for history of branch.
498
'forward' is from earliest to latest
499
'reverse' is from latest to earliest
501
rh = self.revision_history()
502
if direction == 'forward':
507
elif direction == 'reverse':
513
raise BzrError('invalid history direction %r' % direction)
287
"""Return sequence of revision hashes on to this branch."""
288
raise NotImplementedError('revision_history is abstract')
517
291
"""Return current revision number for this branch.
642
387
Note that to_name is only the last component of the new name;
643
388
this doesn't change the directory.
645
self._need_writelock()
646
## TODO: Option to move IDs only
647
assert not isinstance(from_paths, basestring)
648
tree = self.working_tree()
650
to_abs = self.abspath(to_name)
651
if not isdir(to_abs):
652
bailout("destination %r is not a directory" % to_abs)
653
if not tree.has_filename(to_name):
654
bailout("destination %r not in working directory" % to_abs)
655
to_dir_id = inv.path2id(to_name)
656
if to_dir_id == None and to_name != '':
657
bailout("destination %r is not a versioned directory" % to_name)
658
to_dir_ie = inv[to_dir_id]
659
if to_dir_ie.kind not in ('directory', 'root_directory'):
660
bailout("destination %r is not a directory" % to_abs)
662
to_idpath = Set(inv.get_idpath(to_dir_id))
665
if not tree.has_filename(f):
666
bailout("%r does not exist in working tree" % f)
667
f_id = inv.path2id(f)
669
bailout("%r is not versioned" % f)
670
name_tail = splitpath(f)[-1]
671
dest_path = appendpath(to_name, name_tail)
672
if tree.has_filename(dest_path):
673
bailout("destination %r already exists" % dest_path)
674
if f_id in to_idpath:
675
bailout("can't move %r to a subdirectory of itself" % f)
677
# OK, so there's a race here, it's possible that someone will
678
# create a file in this interval and then the rename might be
679
# left half-done. But we should have caught most problems.
682
name_tail = splitpath(f)[-1]
683
dest_path = appendpath(to_name, name_tail)
684
print "%s => %s" % (f, dest_path)
685
inv.rename(inv.path2id(f), to_dir_id, name_tail)
687
os.rename(self.abspath(f), self.abspath(dest_path))
689
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
690
["rename rolled back"])
692
self._write_inventory(inv)
697
class ScratchBranch(Branch):
698
"""Special test class: a branch that cleans up after itself.
700
>>> b = ScratchBranch()
708
def __init__(self, files=[], dirs=[]):
709
"""Make a test branch.
711
This creates a temporary directory and runs init-tree in it.
713
If any files are listed, they are created in the working copy.
715
Branch.__init__(self, tempfile.mkdtemp(), init=True)
717
os.mkdir(self.abspath(d))
390
This returns a list of (from_path, to_path) pairs for each
393
raise NotImplementedError('move is abstract')
395
def get_parent(self):
396
"""Return the parent location of the branch.
398
This is the default location for push/pull/missing. The usual
399
pattern is that the user can override it by specifying a
402
raise NotImplementedError('get_parent is abstract')
404
def get_submit_branch(self):
405
"""Return the submit location of the branch.
407
This is the default location for bundle. The usual
408
pattern is that the user can override it by specifying a
411
return self.get_config().get_user_option('submit_branch')
413
def set_submit_branch(self, location):
414
"""Return the submit location of the branch.
416
This is the default location for bundle. The usual
417
pattern is that the user can override it by specifying a
420
self.get_config().set_user_option('submit_branch', location)
422
def get_push_location(self):
423
"""Return the None or the location to push this branch to."""
424
raise NotImplementedError('get_push_location is abstract')
426
def set_push_location(self, location):
427
"""Set a new push location for this branch."""
428
raise NotImplementedError('set_push_location is abstract')
430
def set_parent(self, url):
431
raise NotImplementedError('set_parent is abstract')
435
"""Synchronise this branch with the master branch if any.
437
:return: None or the last_revision pivoted out during the update.
441
def check_revno(self, revno):
443
Check whether a revno corresponds to any revision.
444
Zero (the NULL revision) is considered valid.
447
self.check_real_revno(revno)
720
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
449
def check_real_revno(self, revno):
451
Check whether a revno corresponds to a real revision.
452
Zero (the NULL revision) is considered invalid
454
if revno < 1 or revno > self.revno():
455
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.
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)
723
923
def __del__(self):
727
"""Destroy the test branch, removing the scratch directory."""
729
mutter("delete ScratchBranch %s" % self.base)
730
shutil.rmtree(self.base)
732
# Work around for shutil.rmtree failing on Windows when
733
# readonly files are encountered
734
mutter("hit exception in destroying ScratchBranch: %s" % e)
735
for root, dirs, files in os.walk(self.base, topdown=False):
737
os.chmod(os.path.join(root, name), 0700)
738
shutil.rmtree(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')
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
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
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)
743
1398
######################################################################
747
def is_control_file(filename):
748
## FIXME: better check
749
filename = os.path.normpath(filename)
750
while filename != '':
751
head, tail = os.path.split(filename)
752
## mutter('check %r for control file' % ((head, tail), ))
753
if tail == bzrlib.BZRDIR:
762
def gen_file_id(name):
763
"""Return new file id.
765
This should probably generate proper UUIDs, but for the moment we
766
cope with just randomness because running uuidgen every time is
768
idx = name.rfind('/')
770
name = name[idx+1 : ]
771
idx = name.rfind('\\')
773
name = name[idx+1 : ]
775
name = name.lstrip('.')
777
s = hexlify(rand_bytes(8))
778
return '-'.join((name, compact_date(time.time()), s))
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)
added
removed
bzrlib/branch.py
