1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 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
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, \
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
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)
60
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
62
head, tail = os.path.split(f)
64
# reached the root, whatever that may be
65
raise BzrError('%r is not in a branch' % orig_f)
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.tag import (
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.hooks import Hooks
44
from bzrlib.symbol_versioning import (
48
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
51
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
52
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
53
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
56
# TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations. .. nb thats
62
# what the transaction identity map provides
70
65
######################################################################
74
69
"""Branch holding a history of revisions.
77
Base directory of the branch.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""Open an existing branch which contains url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
If there is one, it is returned, along with the unused portion of url.
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
150
def lock_write(self):
151
raise NotImplementedError(self.lock_write)
154
raise NotImplementedError(self.lock_read)
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
226
def abspath(self, name):
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
81
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
82
"""Create new branch object at a particular location.
84
base -- Base directory for the branch.
86
init -- If True, create new control files in a previously
87
unversioned directory. If False, the branch must already
90
find_root -- If true and init is false, find the root of the
91
existing branch containing base.
93
In the test suite, creation of new trees is tested using the
94
`ScratchBranch` class.
97
self.base = os.path.realpath(base)
100
self.base = find_branch_root(base)
102
self.base = os.path.realpath(base)
103
if not isdir(self.controlfilename('.')):
104
bailout("not a bzr branch: %s" % quotefn(base),
105
['use "bzr init" to initialize a new working tree',
106
'current bzr can only operate from top-of-tree'])
110
self.text_store = ImmutableStore(self.controlfilename('text-store'))
111
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
112
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
116
return '%s(%r)' % (self.__class__.__name__, self.base)
123
def lock(self, mode='w'):
124
"""Lock the on-disk branch, excluding other processes."""
130
om = os.O_WRONLY | os.O_CREAT
135
raise BzrError("invalid locking mode %r" % mode)
138
lockfile = os.open(self.controlfilename('branch-lock'), om)
140
if e.errno == errno.ENOENT:
141
# might not exist on branches from <0.0.4
142
self.controlfile('branch-lock', 'w').close()
143
lockfile = os.open(self.controlfilename('branch-lock'), om)
147
fcntl.lockf(lockfile, lm)
149
fcntl.lockf(lockfile, fcntl.LOCK_UN)
151
self._lockmode = None
153
self._lockmode = mode
155
warning("please write a locking method for platform %r" % sys.platform)
157
self._lockmode = None
159
self._lockmode = mode
162
def _need_readlock(self):
163
if self._lockmode not in ['r', 'w']:
164
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
166
def _need_writelock(self):
167
if self._lockmode not in ['w']:
168
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
171
def abspath(self, name):
172
"""Return absolute filename for something in the branch"""
173
return os.path.join(self.base, name)
176
def relpath(self, path):
177
"""Return path relative to this branch of something inside it.
179
Raises an error if path is not in this branch."""
180
rp = os.path.realpath(path)
182
if not rp.startswith(self.base):
183
bailout("path %r is not within branch %r" % (rp, self.base))
184
rp = rp[len(self.base):]
185
rp = rp.lstrip(os.sep)
189
def controlfilename(self, file_or_path):
190
"""Return location relative to branch."""
191
if isinstance(file_or_path, types.StringTypes):
192
file_or_path = [file_or_path]
193
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
196
def controlfile(self, file_or_path, mode='r'):
197
"""Open a control file for this branch.
199
There are two classes of file in the control directory: text
200
and binary. binary files are untranslated byte streams. Text
201
control files are stored with Unix newlines and in UTF-8, even
202
if the platform or locale defaults are different.
205
fn = self.controlfilename(file_or_path)
207
if mode == 'rb' or mode == 'wb':
208
return file(fn, mode)
209
elif mode == 'r' or mode == 'w':
210
# open in binary mode anyhow so there's no newline translation;
211
# codecs uses line buffering by default; don't want that.
213
return codecs.open(fn, mode + 'b', 'utf-8',
216
raise BzrError("invalid controlfile mode %r" % mode)
220
def _make_control(self):
221
os.mkdir(self.controlfilename([]))
222
self.controlfile('README', 'w').write(
223
"This is a Bazaar-NG control directory.\n"
224
"Do not change any files in this directory.")
225
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
226
for d in ('text-store', 'inventory-store', 'revision-store'):
227
os.mkdir(self.controlfilename(d))
228
for f in ('revision-history', 'merged-patches',
229
'pending-merged-patches', 'branch-name',
231
self.controlfile(f, 'w').write('')
232
mutter('created control directory in ' + self.base)
233
Inventory().write_xml(self.controlfile('inventory','w'))
236
def _check_format(self):
237
"""Check this branch format is supported.
239
The current tool only supports the current unstable format.
241
In the future, we might need different in-memory Branch
242
classes to support downlevel branches. But not yet.
244
# This ignores newlines so that we can open branches created
245
# on Windows from Linux and so on. I think it might be better
246
# to always make all internal files in unix format.
247
fmt = self.controlfile('branch-format', 'r').read()
248
fmt.replace('\r\n', '')
249
if fmt != BZR_BRANCH_FORMAT:
250
bailout('sorry, branch format %r not supported' % fmt,
251
['use a different bzr version',
252
'or remove the .bzr directory and "bzr init" again'])
255
def read_working_inventory(self):
256
"""Read the working inventory."""
257
self._need_readlock()
259
# ElementTree does its own conversion from UTF-8, so open in
261
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
262
mutter("loaded inventory of %d items in %f"
263
% (len(inv), time.time() - before))
267
def _write_inventory(self, inv):
268
"""Update the working inventory.
270
That is to say, the inventory describing changes underway, that
271
will be committed to the next revision.
273
self._need_writelock()
274
## TODO: factor out to atomicfile? is rename safe on windows?
275
## TODO: Maybe some kind of clean/dirty marker on inventory?
276
tmpfname = self.controlfilename('inventory.tmp')
277
tmpf = file(tmpfname, 'wb')
280
inv_fname = self.controlfilename('inventory')
281
if sys.platform == 'win32':
283
os.rename(tmpfname, inv_fname)
284
mutter('wrote working inventory')
287
inventory = property(read_working_inventory, _write_inventory, None,
288
"""Inventory for the working copy.""")
291
def add(self, files, verbose=False):
292
"""Make files versioned.
294
Note that the command line normally calls smart_add instead.
296
This puts the files in the Added state, so that they will be
297
recorded by the next commit.
299
TODO: Perhaps have an option to add the ids even if the files do
302
TODO: Perhaps return the ids of the files? But then again it
303
is easy to retrieve them if they're needed.
305
TODO: Option to specify file id.
307
TODO: Adding a directory should optionally recurse down and
308
add all non-ignored children. Perhaps do that in a
311
>>> b = ScratchBranch(files=['foo'])
312
>>> 'foo' in b.unknowns()
317
>>> 'foo' in b.unknowns()
319
>>> bool(b.inventory.path2id('foo'))
325
Traceback (most recent call last):
327
BzrError: ('foo is already versioned', [])
329
>>> b.add(['nothere'])
330
Traceback (most recent call last):
331
BzrError: ('cannot add: not a regular file or directory: nothere', [])
333
self._need_writelock()
335
# TODO: Re-adding a file that is removed in the working copy
336
# should probably put it back with the previous ID.
337
if isinstance(files, types.StringTypes):
340
inv = self.read_working_inventory()
342
if is_control_file(f):
343
bailout("cannot add control file %s" % quotefn(f))
348
bailout("cannot add top-level %r" % f)
350
fullpath = os.path.normpath(self.abspath(f))
353
kind = file_kind(fullpath)
355
# maybe something better?
356
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
358
if kind != 'file' and kind != 'directory':
359
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
361
file_id = gen_file_id(f)
362
inv.add_path(f, kind=kind, file_id=file_id)
365
show_status('A', kind, quotefn(f))
367
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
369
self._write_inventory(inv)
372
def print_file(self, file, revno):
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
327
def print_file(self, file, revision_id):
373
328
"""Print `file` to stdout."""
374
self._need_readlock()
375
tree = self.revision_tree(self.lookup_revision(revno))
376
# use inventory as it was in that revision
377
file_id = tree.inventory.path2id(file)
379
bailout("%r is not present in revision %d" % (file, revno))
380
tree.print_file(file_id)
383
def remove(self, files, verbose=False):
384
"""Mark nominated files for removal from the inventory.
386
This does not remove their text. This does not run on
388
TODO: Refuse to remove modified files unless --force is given?
390
>>> b = ScratchBranch(files=['foo'])
392
>>> b.inventory.has_filename('foo')
395
>>> b.working_tree().has_filename('foo')
397
>>> b.inventory.has_filename('foo')
400
>>> b = ScratchBranch(files=['foo'])
405
>>> b.inventory.has_filename('foo')
407
>>> b.basis_tree().has_filename('foo')
409
>>> b.working_tree().has_filename('foo')
412
TODO: Do something useful with directories.
414
TODO: Should this remove the text or not? Tough call; not
415
removing may be useful and the user can just use use rm, and
416
is the opposite of add. Removing it is consistent with most
417
other tools. Maybe an option.
419
## TODO: Normalize names
420
## TODO: Remove nested loops; better scalability
421
self._need_writelock()
423
if isinstance(files, types.StringTypes):
426
tree = self.working_tree()
429
# do this before any modifications
433
bailout("cannot remove unversioned file %s" % quotefn(f))
434
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
436
# having remove it, it must be either ignored or unknown
437
if tree.is_ignored(f):
441
show_status(new_status, inv[fid].kind, quotefn(f))
444
self._write_inventory(inv)
448
"""Return all unknown files.
450
These are files in the working directory that are not versioned or
451
control files or ignored.
453
>>> b = ScratchBranch(files=['foo', 'foo~'])
454
>>> list(b.unknowns())
457
>>> list(b.unknowns())
460
>>> list(b.unknowns())
463
return self.working_tree().unknowns()
466
def commit(self, message, timestamp=None, timezone=None,
469
"""Commit working copy as a new revision.
471
The basic approach is to add all the file texts into the
472
store, then the inventory, then make a new revision pointing
473
to that inventory and store that.
475
This is not quite safe if the working copy changes during the
476
commit; for the moment that is simply not allowed. A better
477
approach is to make a temporary copy of the files before
478
computing their hashes, and then add those hashes in turn to
479
the inventory. This should mean at least that there are no
480
broken hash pointers. There is no way we can get a snapshot
481
of the whole directory at an instant. This would also have to
482
be robust against files disappearing, moving, etc. So the
483
whole thing is a bit hard.
485
timestamp -- if not None, seconds-since-epoch for a
486
postdated/predated commit.
488
self._need_writelock()
490
## TODO: Show branch names
492
# TODO: Don't commit if there are no changes, unless forced?
494
# First walk over the working inventory; and both update that
495
# and also build a new revision inventory. The revision
496
# inventory needs to hold the text-id, sha1 and size of the
497
# actual file versions committed in the revision. (These are
498
# not present in the working inventory.) We also need to
499
# detect missing/deleted files, and remove them from the
502
work_inv = self.read_working_inventory()
504
basis = self.basis_tree()
505
basis_inv = basis.inventory
507
for path, entry in work_inv.iter_entries():
508
## TODO: Cope with files that have gone missing.
510
## TODO: Check that the file kind has not changed from the previous
511
## revision of this file (if any).
515
p = self.abspath(path)
516
file_id = entry.file_id
517
mutter('commit prep file %s, id %r ' % (p, file_id))
519
if not os.path.exists(p):
520
mutter(" file is missing, removing from inventory")
522
show_status('D', entry.kind, quotefn(path))
523
missing_ids.append(file_id)
526
# TODO: Handle files that have been deleted
528
# TODO: Maybe a special case for empty files? Seems a
529
# waste to store them many times.
533
if basis_inv.has_id(file_id):
534
old_kind = basis_inv[file_id].kind
535
if old_kind != entry.kind:
536
bailout("entry %r changed kind from %r to %r"
537
% (file_id, old_kind, entry.kind))
539
if entry.kind == 'directory':
541
bailout("%s is entered as directory but not a directory" % quotefn(p))
542
elif entry.kind == 'file':
544
bailout("%s is entered as file but is not a file" % quotefn(p))
546
content = file(p, 'rb').read()
548
entry.text_sha1 = sha_string(content)
549
entry.text_size = len(content)
551
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
553
and (old_ie.text_size == entry.text_size)
554
and (old_ie.text_sha1 == entry.text_sha1)):
555
## assert content == basis.get_file(file_id).read()
556
entry.text_id = basis_inv[file_id].text_id
557
mutter(' unchanged from previous text_id {%s}' %
561
entry.text_id = gen_file_id(entry.name)
562
self.text_store.add(content, entry.text_id)
563
mutter(' stored with text_id {%s}' % entry.text_id)
567
elif (old_ie.name == entry.name
568
and old_ie.parent_id == entry.parent_id):
573
show_status(state, entry.kind, quotefn(path))
575
for file_id in missing_ids:
576
# have to do this later so we don't mess up the iterator.
577
# since parents may be removed before their children we
580
# FIXME: There's probably a better way to do this; perhaps
581
# the workingtree should know how to filter itself.
582
if work_inv.has_id(file_id):
583
del work_inv[file_id]
586
inv_id = rev_id = _gen_revision_id(time.time())
588
inv_tmp = tempfile.TemporaryFile()
589
inv.write_xml(inv_tmp)
591
self.inventory_store.add(inv_tmp, inv_id)
592
mutter('new inventory_id is {%s}' % inv_id)
594
self._write_inventory(work_inv)
596
if timestamp == None:
597
timestamp = time.time()
599
if committer == None:
600
committer = username()
603
timezone = local_time_offset()
605
mutter("building commit log message")
606
rev = Revision(timestamp=timestamp,
609
precursor = self.last_patch(),
614
rev_tmp = tempfile.TemporaryFile()
615
rev.write_xml(rev_tmp)
617
self.revision_store.add(rev_tmp, rev_id)
618
mutter("new revision_id is {%s}" % rev_id)
620
## XXX: Everything up to here can simply be orphaned if we abort
621
## the commit; it will leave junk files behind but that doesn't
624
## TODO: Read back the just-generated changeset, and make sure it
625
## applies and recreates the right state.
627
## TODO: Also calculate and store the inventory SHA1
628
mutter("committing patch r%d" % (self.revno() + 1))
631
self.append_revision(rev_id)
634
note("commited r%d" % self.revno())
637
def append_revision(self, revision_id):
638
mutter("add {%s} to revision-history" % revision_id)
639
rev_history = self.revision_history()
641
tmprhname = self.controlfilename('revision-history.tmp')
642
rhname = self.controlfilename('revision-history')
644
f = file(tmprhname, 'wt')
645
rev_history.append(revision_id)
646
f.write('\n'.join(rev_history))
650
if sys.platform == 'win32':
652
os.rename(tmprhname, rhname)
656
def get_revision(self, revision_id):
657
"""Return the Revision object for a named revision"""
658
self._need_readlock()
659
r = Revision.read_xml(self.revision_store[revision_id])
660
assert r.revision_id == revision_id
664
def get_inventory(self, inventory_id):
665
"""Get Inventory object by hash.
667
TODO: Perhaps for this and similar methods, take a revision
668
parameter which can be either an integer revno or a
670
self._need_readlock()
671
i = Inventory.read_xml(self.inventory_store[inventory_id])
675
def get_revision_inventory(self, revision_id):
676
"""Return inventory of a past revision."""
677
self._need_readlock()
678
if revision_id == None:
681
return self.get_inventory(self.get_revision(revision_id).inventory_id)
329
raise NotImplementedError(self.print_file)
331
def set_revision_history(self, rev_history):
332
raise NotImplementedError(self.set_revision_history)
334
def _cache_revision_history(self, rev_history):
335
"""Set the cached revision history to rev_history.
337
The revision_history method will use this cache to avoid regenerating
338
the revision history.
340
This API is semi-public; it only for use by subclasses, all other code
341
should consider it to be private.
343
self._revision_history_cache = rev_history
345
def _cache_revision_id_to_revno(self, revision_id_to_revno):
346
"""Set the cached revision_id => revno map to revision_id_to_revno.
348
This API is semi-public; it only for use by subclasses, all other code
349
should consider it to be private.
351
self._revision_id_to_revno_cache = revision_id_to_revno
353
def _clear_cached_state(self):
354
"""Clear any cached data on this branch, e.g. cached revision history.
356
This means the next call to revision_history will need to call
357
_gen_revision_history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = None
363
self._revision_id_to_revno_cache = None
365
def _gen_revision_history(self):
366
"""Return sequence of revision hashes on to this branch.
368
Unlike revision_history, this method always regenerates or rereads the
369
revision history, i.e. it does not cache the result, so repeated calls
372
Concrete subclasses should override this instead of revision_history so
373
that subclasses do not need to deal with caching logic.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
raise NotImplementedError(self._gen_revision_history)
684
381
def revision_history(self):
685
"""Return sequence of revision hashes on to this branch.
687
>>> ScratchBranch().revision_history()
690
self._need_readlock()
691
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
694
def enum_history(self, direction):
695
"""Return (revno, revision_id) for history of branch.
698
'forward' is from earliest to latest
699
'reverse' is from latest to earliest
701
rh = self.revision_history()
702
if direction == 'forward':
707
elif direction == 'reverse':
382
"""Return sequence of revision ids on this branch.
384
This method will cache the revision history for as long as it is safe to
387
if 'evil' in debug.debug_flags:
388
mutter_callsite(3, "revision_history scales with history.")
389
if self._revision_history_cache is not None:
390
history = self._revision_history_cache
713
raise BzrError('invalid history direction %r' % direction)
392
history = self._gen_revision_history()
393
self._cache_revision_history(history)
717
397
"""Return current revision number for this branch.
719
399
That is equivalent to the number of revisions committed to
722
>>> b = ScratchBranch()
725
>>> b.commit('no foo')
729
return len(self.revision_history())
732
def last_patch(self):
733
"""Return last patch hash, or None if no history.
735
>>> ScratchBranch().last_patch() == None
738
ph = self.revision_history()
402
return self.last_revision_info()[0]
405
"""Older format branches cannot bind or unbind."""
406
raise errors.UpgradeRequired(self.base)
408
def set_append_revisions_only(self, enabled):
409
"""Older format branches are never restricted to append-only"""
410
raise errors.UpgradeRequired(self.base)
412
def last_revision(self):
413
"""Return last revision id, or NULL_REVISION."""
414
return self.last_revision_info()[1]
416
def last_revision_info(self):
417
"""Return information about the last revision.
419
:return: A tuple (revno, last_revision_id).
421
rh = self.revision_history()
424
return (revno, rh[-1])
426
return (0, _mod_revision.NULL_REVISION)
428
@deprecated_method(deprecated_in((1, 6, 0)))
429
def missing_revisions(self, other, stop_revision=None):
430
"""Return a list of new revisions that would perfectly fit.
745
def lookup_revision(self, revno):
746
"""Return revision hash for revision number."""
432
If self and other have not diverged, return a list of the revisions
433
present in other, but missing from self.
435
self_history = self.revision_history()
436
self_len = len(self_history)
437
other_history = other.revision_history()
438
other_len = len(other_history)
439
common_index = min(self_len, other_len) -1
440
if common_index >= 0 and \
441
self_history[common_index] != other_history[common_index]:
442
raise errors.DivergedBranches(self, other)
444
if stop_revision is None:
445
stop_revision = other_len
447
if stop_revision > other_len:
448
raise errors.NoSuchRevision(self, stop_revision)
449
return other_history[self_len:stop_revision]
452
def update_revisions(self, other, stop_revision=None, overwrite=False,
454
"""Pull in new perfect-fit revisions.
456
:param other: Another Branch to pull from
457
:param stop_revision: Updated until the given revision
458
:param overwrite: Always set the branch pointer, rather than checking
459
to see if it is a proper descendant.
460
:param graph: A Graph object that can be used to query history
461
information. This can be None.
466
other_revno, other_last_revision = other.last_revision_info()
467
stop_revno = None # unknown
468
if stop_revision is None:
469
stop_revision = other_last_revision
470
if _mod_revision.is_null(stop_revision):
471
# if there are no commits, we're done.
473
stop_revno = other_revno
475
# what's the current last revision, before we fetch [and change it
477
last_rev = _mod_revision.ensure_null(self.last_revision())
478
# we fetch here so that we don't process data twice in the common
479
# case of having something to pull, and so that the check for
480
# already merged can operate on the just fetched graph, which will
481
# be cached in memory.
482
self.fetch(other, stop_revision)
483
# Check to see if one is an ancestor of the other
486
graph = self.repository.get_graph()
487
heads = graph.heads([stop_revision, last_rev])
488
if heads == set([last_rev]):
489
# The current revision is a decendent of the target,
492
elif heads == set([stop_revision, last_rev]):
493
# These branches have diverged
494
raise errors.DivergedBranches(self, other)
495
elif heads != set([stop_revision]):
496
raise AssertionError("invalid heads: %r" % heads)
497
if stop_revno is None:
499
graph = self.repository.get_graph()
500
this_revno, this_last_revision = self.last_revision_info()
501
stop_revno = graph.find_distance_to_null(stop_revision,
502
[(other_last_revision, other_revno),
503
(this_last_revision, this_revno)])
504
self.set_last_revision_info(stop_revno, stop_revision)
510
def revision_id_to_revno(self, revision_id):
511
"""Given a revision id, return its revno"""
512
if _mod_revision.is_null(revision_id):
514
history = self.revision_history()
516
return history.index(revision_id) + 1
518
raise errors.NoSuchRevision(self, revision_id)
520
def get_rev_id(self, revno, history=None):
521
"""Find the revision id of the specified revno."""
751
# list is 0-based; revisions are 1-based
752
return self.revision_history()[revno-1]
754
raise BzrError("no such revision %s" % revno)
757
def revision_tree(self, revision_id):
758
"""Return Tree for a revision on this branch.
760
`revision_id` may be None for the null revision, in which case
761
an `EmptyTree` is returned."""
762
self._need_readlock()
763
if revision_id == None:
766
inv = self.get_revision_inventory(revision_id)
767
return RevisionTree(self.text_store, inv)
770
def working_tree(self):
771
"""Return a `Tree` for the working copy."""
772
return WorkingTree(self.base, self.read_working_inventory())
523
return _mod_revision.NULL_REVISION
525
history = self.revision_history()
526
if revno <= 0 or revno > len(history):
527
raise errors.NoSuchRevision(self, revno)
528
return history[revno - 1]
530
def pull(self, source, overwrite=False, stop_revision=None,
531
possible_transports=None, _override_hook_target=None):
532
"""Mirror source into this branch.
534
This branch is considered to be 'local', having low latency.
536
:returns: PullResult instance
538
raise NotImplementedError(self.pull)
540
def push(self, target, overwrite=False, stop_revision=None):
541
"""Mirror this branch into target.
543
This branch is considered to be 'local', having low latency.
545
raise NotImplementedError(self.push)
775
547
def basis_tree(self):
776
"""Return `Tree` object for last revision.
778
If there are no revisions yet, return an `EmptyTree`.
780
>>> b = ScratchBranch(files=['foo'])
781
>>> b.basis_tree().has_filename('foo')
783
>>> b.working_tree().has_filename('foo')
786
>>> b.commit('add foo')
787
>>> b.basis_tree().has_filename('foo')
790
r = self.last_patch()
794
return RevisionTree(self.text_store, self.get_revision_inventory(r))
548
"""Return `Tree` object for last revision."""
549
return self.repository.revision_tree(self.last_revision())
798
551
def rename_one(self, from_rel, to_rel):
799
552
"""Rename one file.
801
554
This can change the directory or the filename or both.
803
self._need_writelock()
804
tree = self.working_tree()
806
if not tree.has_filename(from_rel):
807
bailout("can't rename: old working file %r does not exist" % from_rel)
808
if tree.has_filename(to_rel):
809
bailout("can't rename: new working file %r already exists" % to_rel)
811
file_id = inv.path2id(from_rel)
813
bailout("can't rename: old name %r is not versioned" % from_rel)
815
if inv.path2id(to_rel):
816
bailout("can't rename: new name %r is already versioned" % to_rel)
818
to_dir, to_tail = os.path.split(to_rel)
819
to_dir_id = inv.path2id(to_dir)
820
if to_dir_id == None and to_dir != '':
821
bailout("can't determine destination directory id for %r" % to_dir)
823
mutter("rename_one:")
824
mutter(" file_id {%s}" % file_id)
825
mutter(" from_rel %r" % from_rel)
826
mutter(" to_rel %r" % to_rel)
827
mutter(" to_dir %r" % to_dir)
828
mutter(" to_dir_id {%s}" % to_dir_id)
830
inv.rename(file_id, to_dir_id, to_tail)
832
print "%s => %s" % (from_rel, to_rel)
834
from_abs = self.abspath(from_rel)
835
to_abs = self.abspath(to_rel)
837
os.rename(from_abs, to_abs)
839
bailout("failed to rename %r to %r: %s"
840
% (from_abs, to_abs, e[1]),
841
["rename rolled back"])
843
self._write_inventory(inv)
556
raise NotImplementedError(self.rename_one)
847
558
def move(self, from_paths, to_name):
855
566
Note that to_name is only the last component of the new name;
856
567
this doesn't change the directory.
858
self._need_writelock()
859
## TODO: Option to move IDs only
860
assert not isinstance(from_paths, basestring)
861
tree = self.working_tree()
863
to_abs = self.abspath(to_name)
864
if not isdir(to_abs):
865
bailout("destination %r is not a directory" % to_abs)
866
if not tree.has_filename(to_name):
867
bailout("destination %r not in working directory" % to_abs)
868
to_dir_id = inv.path2id(to_name)
869
if to_dir_id == None and to_name != '':
870
bailout("destination %r is not a versioned directory" % to_name)
871
to_dir_ie = inv[to_dir_id]
872
if to_dir_ie.kind not in ('directory', 'root_directory'):
873
bailout("destination %r is not a directory" % to_abs)
875
to_idpath = Set(inv.get_idpath(to_dir_id))
878
if not tree.has_filename(f):
879
bailout("%r does not exist in working tree" % f)
880
f_id = inv.path2id(f)
882
bailout("%r is not versioned" % f)
883
name_tail = splitpath(f)[-1]
884
dest_path = appendpath(to_name, name_tail)
885
if tree.has_filename(dest_path):
886
bailout("destination %r already exists" % dest_path)
887
if f_id in to_idpath:
888
bailout("can't move %r to a subdirectory of itself" % f)
890
# OK, so there's a race here, it's possible that someone will
891
# create a file in this interval and then the rename might be
892
# left half-done. But we should have caught most problems.
895
name_tail = splitpath(f)[-1]
896
dest_path = appendpath(to_name, name_tail)
897
print "%s => %s" % (f, dest_path)
898
inv.rename(inv.path2id(f), to_dir_id, name_tail)
900
os.rename(self.abspath(f), self.abspath(dest_path))
902
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
903
["rename rolled back"])
905
self._write_inventory(inv)
909
def show_status(self, show_all=False, file_list=None):
910
"""Display single-line status for non-ignored working files.
912
The list is show sorted in order by file name.
914
>>> b = ScratchBranch(files=['foo', 'foo~'])
920
>>> b.commit("add foo")
922
>>> os.unlink(b.abspath('foo'))
926
self._need_readlock()
928
# We have to build everything into a list first so that it can
929
# sorted by name, incorporating all the different sources.
931
# FIXME: Rather than getting things in random order and then sorting,
932
# just step through in order.
934
# Interesting case: the old ID for a file has been removed,
935
# but a new file has been created under that name.
937
old = self.basis_tree()
938
new = self.working_tree()
940
items = diff_trees(old, new)
941
# We want to filter out only if any file was provided in the file_list.
942
if isinstance(file_list, list) and len(file_list):
943
items = [item for item in items if item[3] in file_list]
945
for fs, fid, oldname, newname, kind in items:
947
show_status(fs, kind,
948
oldname + ' => ' + newname)
949
elif fs == 'A' or fs == 'M':
950
show_status(fs, kind, newname)
952
show_status(fs, kind, oldname)
955
show_status(fs, kind, newname)
958
show_status(fs, kind, newname)
960
show_status(fs, kind, newname)
569
This returns a list of (from_path, to_path) pairs for each
572
raise NotImplementedError(self.move)
574
def get_parent(self):
575
"""Return the parent location of the branch.
577
This is the default location for push/pull/missing. The usual
578
pattern is that the user can override it by specifying a
581
raise NotImplementedError(self.get_parent)
583
def _set_config_location(self, name, url, config=None,
584
make_relative=False):
586
config = self.get_config()
590
url = urlutils.relative_url(self.base, url)
591
config.set_user_option(name, url, warn_masked=True)
593
def _get_config_location(self, name, config=None):
595
config = self.get_config()
596
location = config.get_user_option(name)
601
def get_submit_branch(self):
602
"""Return the submit location of the branch.
604
This is the default location for bundle. The usual
605
pattern is that the user can override it by specifying a
608
return self.get_config().get_user_option('submit_branch')
610
def set_submit_branch(self, location):
611
"""Return the submit location of the branch.
613
This is the default location for bundle. The usual
614
pattern is that the user can override it by specifying a
617
self.get_config().set_user_option('submit_branch', location,
620
def get_public_branch(self):
621
"""Return the public location of the branch.
623
This is is used by merge directives.
625
return self._get_config_location('public_branch')
627
def set_public_branch(self, location):
628
"""Return the submit location of the branch.
630
This is the default location for bundle. The usual
631
pattern is that the user can override it by specifying a
634
self._set_config_location('public_branch', location)
636
def get_push_location(self):
637
"""Return the None or the location to push this branch to."""
638
push_loc = self.get_config().get_user_option('push_location')
641
def set_push_location(self, location):
642
"""Set a new push location for this branch."""
643
raise NotImplementedError(self.set_push_location)
645
def set_parent(self, url):
646
raise NotImplementedError(self.set_parent)
650
"""Synchronise this branch with the master branch if any.
652
:return: None or the last_revision pivoted out during the update.
656
def check_revno(self, revno):
658
Check whether a revno corresponds to any revision.
659
Zero (the NULL revision) is considered valid.
662
self.check_real_revno(revno)
664
def check_real_revno(self, revno):
666
Check whether a revno corresponds to a real revision.
667
Zero (the NULL revision) is considered invalid
669
if revno < 1 or revno > self.revno():
670
raise errors.InvalidRevisionNumber(revno)
673
def clone(self, to_bzrdir, revision_id=None):
674
"""Clone this branch into to_bzrdir preserving all semantic values.
676
revision_id: if not None, the revision history in the new branch will
677
be truncated to end with revision_id.
679
result = self._format.initialize(to_bzrdir)
680
self.copy_content_into(result, revision_id=revision_id)
684
def sprout(self, to_bzrdir, revision_id=None):
685
"""Create a new line of development from the branch, into to_bzrdir.
687
revision_id: if not None, the revision history in the new branch will
688
be truncated to end with revision_id.
690
result = self._format.initialize(to_bzrdir)
691
self.copy_content_into(result, revision_id=revision_id)
692
result.set_parent(self.bzrdir.root_transport.base)
695
def _synchronize_history(self, destination, revision_id):
696
"""Synchronize last revision and revision history between branches.
698
This version is most efficient when the destination is also a
699
BzrBranch5, but works for BzrBranch6 as long as the revision
700
history is the true lefthand parent history, and all of the revisions
701
are in the destination's repository. If not, set_revision_history
704
:param destination: The branch to copy the history into
705
:param revision_id: The revision-id to truncate history at. May
706
be None to copy complete history.
708
if revision_id == _mod_revision.NULL_REVISION:
710
new_history = self.revision_history()
711
if revision_id is not None and new_history != []:
713
new_history = new_history[:new_history.index(revision_id) + 1]
715
rev = self.repository.get_revision(revision_id)
716
new_history = rev.get_history(self.repository)[1:]
717
destination.set_revision_history(new_history)
720
def copy_content_into(self, destination, revision_id=None):
721
"""Copy the content of self into destination.
723
revision_id: if not None, the revision history in the new branch will
724
be truncated to end with revision_id.
726
self._synchronize_history(destination, revision_id)
728
parent = self.get_parent()
729
except errors.InaccessibleParent, e:
730
mutter('parent was not accessible to copy: %s', e)
733
destination.set_parent(parent)
734
self.tags.merge_to(destination.tags)
738
"""Check consistency of the branch.
740
In particular this checks that revisions given in the revision-history
741
do actually match up in the revision graph, and that they're all
742
present in the repository.
744
Callers will typically also want to check the repository.
746
:return: A BranchCheckResult.
748
mainline_parent_id = None
749
last_revno, last_revision_id = self.last_revision_info()
750
real_rev_history = list(self.repository.iter_reverse_revision_history(
752
real_rev_history.reverse()
753
if len(real_rev_history) != last_revno:
754
raise errors.BzrCheckError('revno does not match len(mainline)'
755
' %s != %s' % (last_revno, len(real_rev_history)))
756
# TODO: We should probably also check that real_rev_history actually
757
# matches self.revision_history()
758
for revision_id in real_rev_history:
760
revision = self.repository.get_revision(revision_id)
761
except errors.NoSuchRevision, e:
762
raise errors.BzrCheckError("mainline revision {%s} not in repository"
764
# In general the first entry on the revision history has no parents.
765
# But it's not illegal for it to have parents listed; this can happen
766
# in imports from Arch when the parents weren't reachable.
767
if mainline_parent_id is not None:
768
if mainline_parent_id not in revision.parent_ids:
769
raise errors.BzrCheckError("previous revision {%s} not listed among "
771
% (mainline_parent_id, revision_id))
772
mainline_parent_id = revision_id
773
return BranchCheckResult(self)
775
def _get_checkout_format(self):
776
"""Return the most suitable metadir for a checkout of this branch.
777
Weaves are used if this branch's repository uses weaves.
779
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
780
from bzrlib.repofmt import weaverepo
781
format = bzrdir.BzrDirMetaFormat1()
782
format.repository_format = weaverepo.RepositoryFormat7()
784
format = self.repository.bzrdir.checkout_metadir()
785
format.set_branch_format(self._format)
788
def create_checkout(self, to_location, revision_id=None,
789
lightweight=False, accelerator_tree=None,
791
"""Create a checkout of a branch.
793
:param to_location: The url to produce the checkout at
794
:param revision_id: The revision to check out
795
:param lightweight: If True, produce a lightweight checkout, otherwise,
796
produce a bound branch (heavyweight checkout)
797
:param accelerator_tree: A tree which can be used for retrieving file
798
contents more quickly than the revision tree, i.e. a workingtree.
799
The revision tree will be used for cases where accelerator_tree's
800
content is different.
801
:param hardlink: If true, hard-link files from accelerator_tree,
803
:return: The tree of the created checkout
805
t = transport.get_transport(to_location)
808
format = self._get_checkout_format()
809
checkout = format.initialize_on_transport(t)
810
from_branch = BranchReferenceFormat().initialize(checkout, self)
812
format = self._get_checkout_format()
813
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
814
to_location, force_new_tree=False, format=format)
815
checkout = checkout_branch.bzrdir
816
checkout_branch.bind(self)
817
# pull up to the specified revision_id to set the initial
818
# branch tip correctly, and seed it with history.
819
checkout_branch.pull(self, stop_revision=revision_id)
821
tree = checkout.create_workingtree(revision_id,
822
from_branch=from_branch,
823
accelerator_tree=accelerator_tree,
825
basis_tree = tree.basis_tree()
826
basis_tree.lock_read()
828
for path, file_id in basis_tree.iter_references():
829
reference_parent = self.reference_parent(file_id, path)
830
reference_parent.create_checkout(tree.abspath(path),
831
basis_tree.get_reference_revision(file_id, path),
838
def reconcile(self, thorough=True):
839
"""Make sure the data stored in this branch is consistent."""
840
from bzrlib.reconcile import BranchReconciler
841
reconciler = BranchReconciler(self, thorough=thorough)
842
reconciler.reconcile()
845
def reference_parent(self, file_id, path):
846
"""Return the parent branch for a tree-reference file_id
847
:param file_id: The file_id of the tree reference
848
:param path: The path of the file_id in the tree
849
:return: A branch associated with the file_id
851
# FIXME should provide multiple branches, based on config
852
return Branch.open(self.bzrdir.root_transport.clone(path).base)
854
def supports_tags(self):
855
return self._format.supports_tags()
858
class BranchFormat(object):
859
"""An encapsulation of the initialization and open routines for a format.
861
Formats provide three things:
862
* An initialization routine,
866
Formats are placed in an dict by their format string for reference
867
during branch opening. Its not required that these be instances, they
868
can be classes themselves with class methods - it simply depends on
869
whether state is needed for a given format or not.
871
Once a format is deprecated, just deprecate the initialize and open
872
methods on the format class. Do not deprecate the object, as the
873
object will be created every time regardless.
876
_default_format = None
877
"""The default format used for new branches."""
880
"""The known formats."""
882
def __eq__(self, other):
883
return self.__class__ is other.__class__
885
def __ne__(self, other):
886
return not (self == other)
889
def find_format(klass, a_bzrdir):
890
"""Return the format for the branch object in a_bzrdir."""
892
transport = a_bzrdir.get_branch_transport(None)
893
format_string = transport.get("format").read()
894
return klass._formats[format_string]
895
except errors.NoSuchFile:
896
raise errors.NotBranchError(path=transport.base)
898
raise errors.UnknownFormatError(format=format_string, kind='branch')
901
def get_default_format(klass):
902
"""Return the current default format."""
903
return klass._default_format
905
def get_reference(self, a_bzrdir):
906
"""Get the target reference of the branch in a_bzrdir.
908
format probing must have been completed before calling
909
this method - it is assumed that the format of the branch
910
in a_bzrdir is correct.
912
:param a_bzrdir: The bzrdir to get the branch data from.
913
:return: None if the branch is not a reference branch.
918
def set_reference(self, a_bzrdir, to_branch):
919
"""Set the target reference of the branch in a_bzrdir.
921
format probing must have been completed before calling
922
this method - it is assumed that the format of the branch
923
in a_bzrdir is correct.
925
:param a_bzrdir: The bzrdir to set the branch reference for.
926
:param to_branch: branch that the checkout is to reference
928
raise NotImplementedError(self.set_reference)
930
def get_format_string(self):
931
"""Return the ASCII format string that identifies this format."""
932
raise NotImplementedError(self.get_format_string)
934
def get_format_description(self):
935
"""Return the short format description for this format."""
936
raise NotImplementedError(self.get_format_description)
938
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
940
"""Initialize a branch in a bzrdir, with specified files
942
:param a_bzrdir: The bzrdir to initialize the branch in
943
:param utf8_files: The files to create as a list of
944
(filename, content) tuples
945
:param set_format: If True, set the format with
946
self.get_format_string. (BzrBranch4 has its format set
948
:return: a branch in this format
950
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
951
branch_transport = a_bzrdir.get_branch_transport(self)
953
'metadir': ('lock', lockdir.LockDir),
954
'branch4': ('branch-lock', lockable_files.TransportLock),
956
lock_name, lock_class = lock_map[lock_type]
957
control_files = lockable_files.LockableFiles(branch_transport,
958
lock_name, lock_class)
959
control_files.create_lock()
960
control_files.lock_write()
962
utf8_files += [('format', self.get_format_string())]
964
for (filename, content) in utf8_files:
965
branch_transport.put_bytes(
967
mode=a_bzrdir._get_file_mode())
969
control_files.unlock()
970
return self.open(a_bzrdir, _found=True)
972
def initialize(self, a_bzrdir):
973
"""Create a branch of this format in a_bzrdir."""
974
raise NotImplementedError(self.initialize)
976
def is_supported(self):
977
"""Is this format supported?
979
Supported formats can be initialized and opened.
980
Unsupported formats may not support initialization or committing or
981
some other features depending on the reason for not being supported.
985
def open(self, a_bzrdir, _found=False):
986
"""Return the branch object for a_bzrdir
988
_found is a private parameter, do not use it. It is used to indicate
989
if format probing has already be done.
991
raise NotImplementedError(self.open)
994
def register_format(klass, format):
995
klass._formats[format.get_format_string()] = format
998
def set_default_format(klass, format):
999
klass._default_format = format
1002
def unregister_format(klass, format):
1003
del klass._formats[format.get_format_string()]
1006
return self.get_format_string().rstrip()
1008
def supports_tags(self):
1009
"""True if this format supports tags stored in the branch"""
1010
return False # by default
1013
class BranchHooks(Hooks):
1014
"""A dictionary mapping hook name to a list of callables for branch hooks.
1016
e.g. ['set_rh'] Is the list of items to be called when the
1017
set_revision_history function is invoked.
1021
"""Create the default hooks.
1023
These are all empty initially, because by default nothing should get
1026
Hooks.__init__(self)
1027
# Introduced in 0.15:
1028
# invoked whenever the revision history has been set
1029
# with set_revision_history. The api signature is
1030
# (branch, revision_history), and the branch will
1033
# invoked after a push operation completes.
1034
# the api signature is
1036
# containing the members
1037
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1038
# where local is the local target branch or None, master is the target
1039
# master branch, and the rest should be self explanatory. The source
1040
# is read locked and the target branches write locked. Source will
1041
# be the local low-latency branch.
1042
self['post_push'] = []
1043
# invoked after a pull operation completes.
1044
# the api signature is
1046
# containing the members
1047
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1048
# where local is the local branch or None, master is the target
1049
# master branch, and the rest should be self explanatory. The source
1050
# is read locked and the target branches write locked. The local
1051
# branch is the low-latency branch.
1052
self['post_pull'] = []
1053
# invoked before a commit operation takes place.
1054
# the api signature is
1055
# (local, master, old_revno, old_revid, future_revno, future_revid,
1056
# tree_delta, future_tree).
1057
# old_revid is NULL_REVISION for the first commit to a branch
1058
# tree_delta is a TreeDelta object describing changes from the basis
1059
# revision, hooks MUST NOT modify this delta
1060
# future_tree is an in-memory tree obtained from
1061
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1062
self['pre_commit'] = []
1063
# invoked after a commit operation completes.
1064
# the api signature is
1065
# (local, master, old_revno, old_revid, new_revno, new_revid)
1066
# old_revid is NULL_REVISION for the first commit to a branch.
1067
self['post_commit'] = []
1068
# invoked after a uncommit operation completes.
1069
# the api signature is
1070
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1071
# local is the local branch or None, master is the target branch,
1072
# and an empty branch recieves new_revno of 0, new_revid of None.
1073
self['post_uncommit'] = []
1075
# Invoked after the tip of a branch changes.
1076
# the api signature is
1077
# (params) where params is a ChangeBranchTipParams with the members
1078
# (branch, old_revno, new_revno, old_revid, new_revid)
1079
self['post_change_branch_tip'] = []
1082
# install the default hooks into the Branch class.
1083
Branch.hooks = BranchHooks()
1086
class ChangeBranchTipParams(object):
1087
"""Object holding parameters passed to *_change_branch_tip hooks.
1089
There are 5 fields that hooks may wish to access:
1091
:ivar branch: the branch being changed
1092
:ivar old_revno: revision number before the change
1093
:ivar new_revno: revision number after the change
1094
:ivar old_revid: revision id before the change
1095
:ivar new_revid: revision id after the change
1097
The revid fields are strings. The revno fields are integers.
1100
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1101
"""Create a group of ChangeBranchTip parameters.
1103
:param branch: The branch being changed.
1104
:param old_revno: Revision number before the change.
1105
:param new_revno: Revision number after the change.
1106
:param old_revid: Tip revision id before the change.
1107
:param new_revid: Tip revision id after the change.
1109
self.branch = branch
1110
self.old_revno = old_revno
1111
self.new_revno = new_revno
1112
self.old_revid = old_revid
1113
self.new_revid = new_revid
1116
class BzrBranchFormat4(BranchFormat):
1117
"""Bzr branch format 4.
1120
- a revision-history file.
1121
- a branch-lock lock file [ to be shared with the bzrdir ]
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Branch format 4"
1128
def initialize(self, a_bzrdir):
1129
"""Create a branch of this format in a_bzrdir."""
1130
utf8_files = [('revision-history', ''),
1131
('branch-name', ''),
1133
return self._initialize_helper(a_bzrdir, utf8_files,
1134
lock_type='branch4', set_format=False)
1137
super(BzrBranchFormat4, self).__init__()
1138
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1140
def open(self, a_bzrdir, _found=False):
1141
"""Return the branch object for a_bzrdir
1143
_found is a private parameter, do not use it. It is used to indicate
1144
if format probing has already be done.
1147
# we are being called directly and must probe.
1148
raise NotImplementedError
1149
return BzrBranch(_format=self,
1150
_control_files=a_bzrdir._control_files,
1152
_repository=a_bzrdir.open_repository())
1155
return "Bazaar-NG branch format 4"
1158
class BzrBranchFormat5(BranchFormat):
1159
"""Bzr branch format 5.
1162
- a revision-history file.
1164
- a lock dir guarding the branch itself
1165
- all of this stored in a branch/ subdirectory
1166
- works with shared repositories.
1168
This format is new in bzr 0.8.
1171
def get_format_string(self):
1172
"""See BranchFormat.get_format_string()."""
1173
return "Bazaar-NG branch format 5\n"
1175
def get_format_description(self):
1176
"""See BranchFormat.get_format_description()."""
1177
return "Branch format 5"
1179
def initialize(self, a_bzrdir):
1180
"""Create a branch of this format in a_bzrdir."""
1181
utf8_files = [('revision-history', ''),
1182
('branch-name', ''),
1184
return self._initialize_helper(a_bzrdir, utf8_files)
1187
super(BzrBranchFormat5, self).__init__()
1188
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1190
def open(self, a_bzrdir, _found=False):
1191
"""Return the branch object for a_bzrdir
1193
_found is a private parameter, do not use it. It is used to indicate
1194
if format probing has already be done.
1197
format = BranchFormat.find_format(a_bzrdir)
1198
if format.__class__ != self.__class__:
1199
raise AssertionError("wrong format %r found for %r" %
1202
transport = a_bzrdir.get_branch_transport(None)
1203
control_files = lockable_files.LockableFiles(transport, 'lock',
1205
return BzrBranch5(_format=self,
1206
_control_files=control_files,
1208
_repository=a_bzrdir.find_repository())
1209
except errors.NoSuchFile:
1210
raise errors.NotBranchError(path=transport.base)
1213
class BzrBranchFormat6(BzrBranchFormat5):
1214
"""Branch format with last-revision and tags.
1216
Unlike previous formats, this has no explicit revision history. Instead,
1217
this just stores the last-revision, and the left-hand history leading
1218
up to there is the history.
1220
This format was introduced in bzr 0.15
1221
and became the default in 0.91.
1224
def get_format_string(self):
1225
"""See BranchFormat.get_format_string()."""
1226
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1228
def get_format_description(self):
1229
"""See BranchFormat.get_format_description()."""
1230
return "Branch format 6"
1232
def initialize(self, a_bzrdir):
1233
"""Create a branch of this format in a_bzrdir."""
1234
utf8_files = [('last-revision', '0 null:\n'),
1235
('branch.conf', ''),
1238
return self._initialize_helper(a_bzrdir, utf8_files)
1240
def open(self, a_bzrdir, _found=False):
1241
"""Return the branch object for a_bzrdir
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
1247
format = BranchFormat.find_format(a_bzrdir)
1248
if format.__class__ != self.__class__:
1249
raise AssertionError("wrong format %r found for %r" %
1251
transport = a_bzrdir.get_branch_transport(None)
1252
control_files = lockable_files.LockableFiles(transport, 'lock',
1254
return BzrBranch6(_format=self,
1255
_control_files=control_files,
1257
_repository=a_bzrdir.find_repository())
1259
def supports_tags(self):
1263
class BranchReferenceFormat(BranchFormat):
1264
"""Bzr branch reference format.
1266
Branch references are used in implementing checkouts, they
1267
act as an alias to the real branch which is at some other url.
1274
def get_format_string(self):
1275
"""See BranchFormat.get_format_string()."""
1276
return "Bazaar-NG Branch Reference Format 1\n"
1278
def get_format_description(self):
1279
"""See BranchFormat.get_format_description()."""
1280
return "Checkout reference format 1"
1282
def get_reference(self, a_bzrdir):
1283
"""See BranchFormat.get_reference()."""
1284
transport = a_bzrdir.get_branch_transport(None)
1285
return transport.get('location').read()
1287
def set_reference(self, a_bzrdir, to_branch):
1288
"""See BranchFormat.set_reference()."""
1289
transport = a_bzrdir.get_branch_transport(None)
1290
location = transport.put_bytes('location', to_branch.base)
1292
def initialize(self, a_bzrdir, target_branch=None):
1293
"""Create a branch of this format in a_bzrdir."""
1294
if target_branch is None:
1295
# this format does not implement branch itself, thus the implicit
1296
# creation contract must see it as uninitializable
1297
raise errors.UninitializableFormat(self)
1298
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1299
branch_transport = a_bzrdir.get_branch_transport(self)
1300
branch_transport.put_bytes('location',
1301
target_branch.bzrdir.root_transport.base)
1302
branch_transport.put_bytes('format', self.get_format_string())
1304
a_bzrdir, _found=True,
1305
possible_transports=[target_branch.bzrdir.root_transport])
1308
super(BranchReferenceFormat, self).__init__()
1309
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1311
def _make_reference_clone_function(format, a_branch):
1312
"""Create a clone() routine for a branch dynamically."""
1313
def clone(to_bzrdir, revision_id=None):
1314
"""See Branch.clone()."""
1315
return format.initialize(to_bzrdir, a_branch)
1316
# cannot obey revision_id limits when cloning a reference ...
1317
# FIXME RBC 20060210 either nuke revision_id for clone, or
1318
# emit some sort of warning/error to the caller ?!
1321
def open(self, a_bzrdir, _found=False, location=None,
1322
possible_transports=None):
1323
"""Return the branch that the branch reference in a_bzrdir points at.
1325
_found is a private parameter, do not use it. It is used to indicate
1326
if format probing has already be done.
1329
format = BranchFormat.find_format(a_bzrdir)
1330
if format.__class__ != self.__class__:
1331
raise AssertionError("wrong format %r found for %r" %
1333
if location is None:
1334
location = self.get_reference(a_bzrdir)
1335
real_bzrdir = bzrdir.BzrDir.open(
1336
location, possible_transports=possible_transports)
1337
result = real_bzrdir.open_branch()
1338
# this changes the behaviour of result.clone to create a new reference
1339
# rather than a copy of the content of the branch.
1340
# I did not use a proxy object because that needs much more extensive
1341
# testing, and we are only changing one behaviour at the moment.
1342
# If we decide to alter more behaviours - i.e. the implicit nickname
1343
# then this should be refactored to introduce a tested proxy branch
1344
# and a subclass of that for use in overriding clone() and ....
1346
result.clone = self._make_reference_clone_function(result)
1350
# formats which have no format string are not discoverable
1351
# and not independently creatable, so are not registered.
1352
__format5 = BzrBranchFormat5()
1353
__format6 = BzrBranchFormat6()
1354
BranchFormat.register_format(__format5)
1355
BranchFormat.register_format(BranchReferenceFormat())
1356
BranchFormat.register_format(__format6)
1357
BranchFormat.set_default_format(__format6)
1358
_legacy_formats = [BzrBranchFormat4(),
1361
class BzrBranch(Branch):
1362
"""A branch stored in the actual filesystem.
1364
Note that it's "local" in the context of the filesystem; it doesn't
1365
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1366
it's writable, and can be accessed via the normal filesystem API.
1368
:ivar _transport: Transport for file operations on this branch's
1369
control files, typically pointing to the .bzr/branch directory.
1370
:ivar repository: Repository for this branch.
1371
:ivar base: The url of the base directory for this branch; the one
1372
containing the .bzr directory.
1375
def __init__(self, _format=None,
1376
_control_files=None, a_bzrdir=None, _repository=None):
1377
"""Create new branch object at a particular location."""
1378
Branch.__init__(self)
1379
if a_bzrdir is None:
1380
raise ValueError('a_bzrdir must be supplied')
1382
self.bzrdir = a_bzrdir
1383
self._base = self.bzrdir.transport.clone('..').base
1384
# XXX: We should be able to just do
1385
# self.base = self.bzrdir.root_transport.base
1386
# but this does not quite work yet -- mbp 20080522
1387
self._format = _format
1388
if _control_files is None:
1389
raise ValueError('BzrBranch _control_files is None')
1390
self.control_files = _control_files
1391
self._transport = _control_files._transport
1392
self.repository = _repository
1395
return '%s(%r)' % (self.__class__.__name__, self.base)
1399
def _get_base(self):
1400
"""Returns the directory containing the control directory."""
1403
base = property(_get_base, doc="The URL for the root of this branch.")
1405
@deprecated_method(deprecated_in((0, 16, 0)))
1406
def abspath(self, name):
1407
"""See Branch.abspath."""
1408
return self._transport.abspath(name)
1410
def is_locked(self):
1411
return self.control_files.is_locked()
1413
def lock_write(self, token=None):
1414
repo_token = self.repository.lock_write()
1416
token = self.control_files.lock_write(token=token)
1418
self.repository.unlock()
1422
def lock_read(self):
1423
self.repository.lock_read()
1425
self.control_files.lock_read()
1427
self.repository.unlock()
1431
# TODO: test for failed two phase locks. This is known broken.
1433
self.control_files.unlock()
1435
self.repository.unlock()
1436
if not self.control_files.is_locked():
1437
# we just released the lock
1438
self._clear_cached_state()
1440
def peek_lock_mode(self):
1441
if self.control_files._lock_count == 0:
1444
return self.control_files._lock_mode
1446
def get_physical_lock_status(self):
1447
return self.control_files.get_physical_lock_status()
1450
def print_file(self, file, revision_id):
1451
"""See Branch.print_file."""
1452
return self.repository.print_file(file, revision_id)
1454
def _write_revision_history(self, history):
1455
"""Factored out of set_revision_history.
1457
This performs the actual writing to disk.
1458
It is intended to be called by BzrBranch5.set_revision_history."""
1459
self._transport.put_bytes(
1460
'revision-history', '\n'.join(history),
1461
mode=self.bzrdir._get_file_mode())
1464
def set_revision_history(self, rev_history):
1465
"""See Branch.set_revision_history."""
1466
if 'evil' in debug.debug_flags:
1467
mutter_callsite(3, "set_revision_history scales with history.")
1468
self._write_revision_history(rev_history)
1469
self._clear_cached_state()
1470
self._cache_revision_history(rev_history)
1471
for hook in Branch.hooks['set_rh']:
1472
hook(self, rev_history)
1474
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1475
"""Run the post_change_branch_tip hooks."""
1476
hooks = Branch.hooks['post_change_branch_tip']
1479
new_revno, new_revid = self.last_revision_info()
1480
params = ChangeBranchTipParams(
1481
self, old_revno, new_revno, old_revid, new_revid)
1486
def set_last_revision_info(self, revno, revision_id):
1487
"""Set the last revision of this branch.
1489
The caller is responsible for checking that the revno is correct
1490
for this revision id.
1492
It may be possible to set the branch last revision to an id not
1493
present in the repository. However, branches can also be
1494
configured to check constraints on history, in which case this may not
1497
revision_id = _mod_revision.ensure_null(revision_id)
1498
old_revno, old_revid = self.last_revision_info()
1499
# this old format stores the full history, but this api doesn't
1500
# provide it, so we must generate, and might as well check it's
1502
history = self._lefthand_history(revision_id)
1503
if len(history) != revno:
1504
raise AssertionError('%d != %d' % (len(history), revno))
1505
self.set_revision_history(history)
1506
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1508
def _gen_revision_history(self):
1509
history = self._transport.get_bytes('revision-history').split('\n')
1510
if history[-1:] == ['']:
1511
# There shouldn't be a trailing newline, but just in case.
1515
def _lefthand_history(self, revision_id, last_rev=None,
1517
if 'evil' in debug.debug_flags:
1518
mutter_callsite(4, "_lefthand_history scales with history.")
1519
# stop_revision must be a descendant of last_revision
1520
graph = self.repository.get_graph()
1521
if last_rev is not None:
1522
if not graph.is_ancestor(last_rev, revision_id):
1523
# our previous tip is not merged into stop_revision
1524
raise errors.DivergedBranches(self, other_branch)
1525
# make a new revision history from the graph
1526
parents_map = graph.get_parent_map([revision_id])
1527
if revision_id not in parents_map:
1528
raise errors.NoSuchRevision(self, revision_id)
1529
current_rev_id = revision_id
1531
# Do not include ghosts or graph origin in revision_history
1532
while (current_rev_id in parents_map and
1533
len(parents_map[current_rev_id]) > 0):
1534
new_history.append(current_rev_id)
1535
current_rev_id = parents_map[current_rev_id][0]
1536
parents_map = graph.get_parent_map([current_rev_id])
1537
new_history.reverse()
1541
def generate_revision_history(self, revision_id, last_rev=None,
1543
"""Create a new revision history that will finish with revision_id.
1545
:param revision_id: the new tip to use.
1546
:param last_rev: The previous last_revision. If not None, then this
1547
must be a ancestory of revision_id, or DivergedBranches is raised.
1548
:param other_branch: The other branch that DivergedBranches should
1549
raise with respect to.
1551
self.set_revision_history(self._lefthand_history(revision_id,
1552
last_rev, other_branch))
1554
def basis_tree(self):
1555
"""See Branch.basis_tree."""
1556
return self.repository.revision_tree(self.last_revision())
1559
def pull(self, source, overwrite=False, stop_revision=None,
1560
_hook_master=None, run_hooks=True, possible_transports=None,
1561
_override_hook_target=None):
1564
:param _hook_master: Private parameter - set the branch to
1565
be supplied as the master to pull hooks.
1566
:param run_hooks: Private parameter - if false, this branch
1567
is being called because it's the master of the primary branch,
1568
so it should not run its hooks.
1569
:param _override_hook_target: Private parameter - set the branch to be
1570
supplied as the target_branch to pull hooks.
1572
result = PullResult()
1573
result.source_branch = source
1574
if _override_hook_target is None:
1575
result.target_branch = self
1577
result.target_branch = _override_hook_target
1580
# We assume that during 'pull' the local repository is closer than
1582
graph = self.repository.get_graph(source.repository)
1583
result.old_revno, result.old_revid = self.last_revision_info()
1584
self.update_revisions(source, stop_revision, overwrite=overwrite,
1586
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1587
result.new_revno, result.new_revid = self.last_revision_info()
1589
result.master_branch = _hook_master
1590
result.local_branch = result.target_branch
962
bailout("weird file state %r" % ((fs, fid),))
966
class ScratchBranch(Branch):
967
"""Special test class: a branch that cleans up after itself.
969
>>> b = ScratchBranch()
1592
result.master_branch = result.target_branch
1593
result.local_branch = None
1595
for hook in Branch.hooks['post_pull']:
1601
def _get_parent_location(self):
1602
_locs = ['parent', 'pull', 'x-pull']
1605
return self._transport.get_bytes(l).strip('\n')
1606
except errors.NoSuchFile:
1611
def push(self, target, overwrite=False, stop_revision=None,
1612
_override_hook_source_branch=None):
1615
This is the basic concrete implementation of push()
1617
:param _override_hook_source_branch: If specified, run
1618
the hooks passing this Branch as the source, rather than self.
1619
This is for use of RemoteBranch, where push is delegated to the
1620
underlying vfs-based Branch.
1622
# TODO: Public option to disable running hooks - should be trivial but
1626
result = self._push_with_bound_branches(target, overwrite,
1628
_override_hook_source_branch=_override_hook_source_branch)
1633
def _push_with_bound_branches(self, target, overwrite,
1635
_override_hook_source_branch=None):
1636
"""Push from self into target, and into target's master if any.
1638
This is on the base BzrBranch class even though it doesn't support
1639
bound branches because the *target* might be bound.
1642
if _override_hook_source_branch:
1643
result.source_branch = _override_hook_source_branch
1644
for hook in Branch.hooks['post_push']:
1647
bound_location = target.get_bound_location()
1648
if bound_location and target.base != bound_location:
1649
# there is a master branch.
1651
# XXX: Why the second check? Is it even supported for a branch to
1652
# be bound to itself? -- mbp 20070507
1653
master_branch = target.get_master_branch()
1654
master_branch.lock_write()
1656
# push into the master from this branch.
1657
self._basic_push(master_branch, overwrite, stop_revision)
1658
# and push into the target branch from this. Note that we push from
1659
# this branch again, because its considered the highest bandwidth
1661
result = self._basic_push(target, overwrite, stop_revision)
1662
result.master_branch = master_branch
1663
result.local_branch = target
1667
master_branch.unlock()
1670
result = self._basic_push(target, overwrite, stop_revision)
1671
# TODO: Why set master_branch and local_branch if there's no
1672
# binding? Maybe cleaner to just leave them unset? -- mbp
1674
result.master_branch = target
1675
result.local_branch = None
1679
def _basic_push(self, target, overwrite, stop_revision):
1680
"""Basic implementation of push without bound branches or hooks.
1682
Must be called with self read locked and target write locked.
1684
result = PushResult()
1685
result.source_branch = self
1686
result.target_branch = target
1687
result.old_revno, result.old_revid = target.last_revision_info()
1689
# We assume that during 'push' this repository is closer than
1691
graph = self.repository.get_graph(target.repository)
1692
target.update_revisions(self, stop_revision, overwrite=overwrite,
1694
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1695
result.new_revno, result.new_revid = target.last_revision_info()
1698
def get_parent(self):
1699
"""See Branch.get_parent."""
1700
parent = self._get_parent_location()
1703
# This is an old-format absolute path to a local branch
1704
# turn it into a url
1705
if parent.startswith('/'):
1706
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1708
return urlutils.join(self.base[:-1], parent)
1709
except errors.InvalidURLJoin, e:
1710
raise errors.InaccessibleParent(parent, self.base)
1712
def set_push_location(self, location):
1713
"""See Branch.set_push_location."""
1714
self.get_config().set_user_option(
1715
'push_location', location,
1716
store=_mod_config.STORE_LOCATION_NORECURSE)
1719
def set_parent(self, url):
1720
"""See Branch.set_parent."""
1721
# TODO: Maybe delete old location files?
1722
# URLs should never be unicode, even on the local fs,
1723
# FIXUP this and get_parent in a future branch format bump:
1724
# read and rewrite the file. RBC 20060125
1726
if isinstance(url, unicode):
1728
url = url.encode('ascii')
1729
except UnicodeEncodeError:
1730
raise errors.InvalidURL(url,
1731
"Urls must be 7-bit ascii, "
1732
"use bzrlib.urlutils.escape")
1733
url = urlutils.relative_url(self.base, url)
1734
self._set_parent_location(url)
1736
def _set_parent_location(self, url):
1738
self._transport.delete('parent')
1740
self._transport.put_bytes('parent', url + '\n',
1741
mode=self.bzrdir._get_file_mode())
1744
class BzrBranch5(BzrBranch):
1745
"""A format 5 branch. This supports new features over plain branches.
1747
It has support for a master_branch which is the data for bound branches.
977
def __init__(self, files=[], dirs=[]):
978
"""Make a test branch.
980
This creates a temporary directory and runs init-tree in it.
982
If any files are listed, they are created in the working copy.
984
Branch.__init__(self, tempfile.mkdtemp(), init=True)
986
os.mkdir(self.abspath(d))
989
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
996
"""Destroy the test branch, removing the scratch directory."""
998
mutter("delete ScratchBranch %s" % self.base)
999
shutil.rmtree(self.base)
1001
# Work around for shutil.rmtree failing on Windows when
1002
# readonly files are encountered
1003
mutter("hit exception in destroying ScratchBranch: %s" % e)
1004
for root, dirs, files in os.walk(self.base, topdown=False):
1006
os.chmod(os.path.join(root, name), 0700)
1007
shutil.rmtree(self.base)
1012
######################################################################
1016
def is_control_file(filename):
1017
## FIXME: better check
1018
filename = os.path.normpath(filename)
1019
while filename != '':
1020
head, tail = os.path.split(filename)
1021
## mutter('check %r for control file' % ((head, tail), ))
1022
if tail == bzrlib.BZRDIR:
1755
super(BzrBranch5, self).__init__(_format=_format,
1756
_control_files=_control_files,
1758
_repository=_repository)
1761
def pull(self, source, overwrite=False, stop_revision=None,
1762
run_hooks=True, possible_transports=None,
1763
_override_hook_target=None):
1764
"""Pull from source into self, updating my master if any.
1766
:param run_hooks: Private parameter - if false, this branch
1767
is being called because it's the master of the primary branch,
1768
so it should not run its hooks.
1770
bound_location = self.get_bound_location()
1771
master_branch = None
1772
if bound_location and source.base != bound_location:
1773
# not pulling from master, so we need to update master.
1774
master_branch = self.get_master_branch(possible_transports)
1775
master_branch.lock_write()
1778
# pull from source into master.
1779
master_branch.pull(source, overwrite, stop_revision,
1781
return super(BzrBranch5, self).pull(source, overwrite,
1782
stop_revision, _hook_master=master_branch,
1783
run_hooks=run_hooks,
1784
_override_hook_target=_override_hook_target)
1787
master_branch.unlock()
1789
def get_bound_location(self):
1791
return self._transport.get_bytes('bound')[:-1]
1792
except errors.NoSuchFile:
1796
def get_master_branch(self, possible_transports=None):
1797
"""Return the branch we are bound to.
1799
:return: Either a Branch, or None
1801
This could memoise the branch, but if thats done
1802
it must be revalidated on each new lock.
1803
So for now we just don't memoise it.
1804
# RBC 20060304 review this decision.
1806
bound_loc = self.get_bound_location()
1810
return Branch.open(bound_loc,
1811
possible_transports=possible_transports)
1812
except (errors.NotBranchError, errors.ConnectionError), e:
1813
raise errors.BoundBranchConnectionFailure(
1817
def set_bound_location(self, location):
1818
"""Set the target where this branch is bound to.
1820
:param location: URL to the target branch
1823
self._transport.put_bytes('bound', location+'\n',
1824
mode=self.bzrdir._get_file_mode())
1827
self._transport.delete('bound')
1828
except errors.NoSuchFile:
1024
if filename == head:
1031
def _gen_revision_id(when):
1032
"""Return new revision-id."""
1033
s = '%s-%s-' % (user_email(), compact_date(when))
1034
s += hexlify(rand_bytes(8))
1038
def gen_file_id(name):
1039
"""Return new file id.
1041
This should probably generate proper UUIDs, but for the moment we
1042
cope with just randomness because running uuidgen every time is
1044
idx = name.rfind('/')
1046
name = name[idx+1 : ]
1047
idx = name.rfind('\\')
1049
name = name[idx+1 : ]
1051
name = name.lstrip('.')
1053
s = hexlify(rand_bytes(8))
1054
return '-'.join((name, compact_date(time.time()), s))
1833
def bind(self, other):
1834
"""Bind this branch to the branch other.
1836
This does not push or pull data between the branches, though it does
1837
check for divergence to raise an error when the branches are not
1838
either the same, or one a prefix of the other. That behaviour may not
1839
be useful, so that check may be removed in future.
1841
:param other: The branch to bind to
1844
# TODO: jam 20051230 Consider checking if the target is bound
1845
# It is debatable whether you should be able to bind to
1846
# a branch which is itself bound.
1847
# Committing is obviously forbidden,
1848
# but binding itself may not be.
1849
# Since we *have* to check at commit time, we don't
1850
# *need* to check here
1852
# we want to raise diverged if:
1853
# last_rev is not in the other_last_rev history, AND
1854
# other_last_rev is not in our history, and do it without pulling
1856
self.set_bound_location(other.base)
1860
"""If bound, unbind"""
1861
return self.set_bound_location(None)
1864
def update(self, possible_transports=None):
1865
"""Synchronise this branch with the master branch if any.
1867
:return: None or the last_revision that was pivoted out during the
1870
master = self.get_master_branch(possible_transports)
1871
if master is not None:
1872
old_tip = _mod_revision.ensure_null(self.last_revision())
1873
self.pull(master, overwrite=True)
1874
if self.repository.get_graph().is_ancestor(old_tip,
1875
_mod_revision.ensure_null(self.last_revision())):
1881
class BzrBranch6(BzrBranch5):
1883
def __init__(self, *args, **kwargs):
1884
super(BzrBranch6, self).__init__(*args, **kwargs)
1885
self._last_revision_info_cache = None
1886
self._partial_revision_history_cache = []
1888
def _clear_cached_state(self):
1889
super(BzrBranch6, self)._clear_cached_state()
1890
self._last_revision_info_cache = None
1891
self._partial_revision_history_cache = []
1894
def last_revision_info(self):
1895
"""Return information about the last revision.
1897
:return: A tuple (revno, revision_id).
1899
if self._last_revision_info_cache is None:
1900
self._last_revision_info_cache = self._last_revision_info()
1901
return self._last_revision_info_cache
1903
def _last_revision_info(self):
1904
revision_string = self._transport.get_bytes('last-revision')
1905
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1906
revision_id = cache_utf8.get_cached_utf8(revision_id)
1908
return revno, revision_id
1910
def _write_last_revision_info(self, revno, revision_id):
1911
"""Simply write out the revision id, with no checks.
1913
Use set_last_revision_info to perform this safely.
1915
Does not update the revision_history cache.
1916
Intended to be called by set_last_revision_info and
1917
_write_revision_history.
1919
revision_id = _mod_revision.ensure_null(revision_id)
1920
out_string = '%d %s\n' % (revno, revision_id)
1921
self._transport.put_bytes('last-revision', out_string,
1922
mode=self.bzrdir._get_file_mode())
1925
def set_last_revision_info(self, revno, revision_id):
1926
revision_id = _mod_revision.ensure_null(revision_id)
1927
old_revno, old_revid = self.last_revision_info()
1928
if self._get_append_revisions_only():
1929
self._check_history_violation(revision_id)
1930
self._write_last_revision_info(revno, revision_id)
1931
self._clear_cached_state()
1932
self._last_revision_info_cache = revno, revision_id
1933
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1935
def _check_history_violation(self, revision_id):
1936
last_revision = _mod_revision.ensure_null(self.last_revision())
1937
if _mod_revision.is_null(last_revision):
1939
if last_revision not in self._lefthand_history(revision_id):
1940
raise errors.AppendRevisionsOnlyViolation(self.base)
1942
def _gen_revision_history(self):
1943
"""Generate the revision history from last revision
1945
last_revno, last_revision = self.last_revision_info()
1946
self._extend_partial_history(stop_index=last_revno-1)
1947
return list(reversed(self._partial_revision_history_cache))
1949
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1950
"""Extend the partial history to include a given index
1952
If a stop_index is supplied, stop when that index has been reached.
1953
If a stop_revision is supplied, stop when that revision is
1954
encountered. Otherwise, stop when the beginning of history is
1957
:param stop_index: The index which should be present. When it is
1958
present, history extension will stop.
1959
:param revision_id: The revision id which should be present. When
1960
it is encountered, history extension will stop.
1962
repo = self.repository
1963
if len(self._partial_revision_history_cache) == 0:
1964
iterator = repo.iter_reverse_revision_history(self.last_revision())
1966
start_revision = self._partial_revision_history_cache[-1]
1967
iterator = repo.iter_reverse_revision_history(start_revision)
1968
#skip the last revision in the list
1969
next_revision = iterator.next()
1970
for revision_id in iterator:
1971
self._partial_revision_history_cache.append(revision_id)
1972
if (stop_index is not None and
1973
len(self._partial_revision_history_cache) > stop_index):
1975
if revision_id == stop_revision:
1978
def _write_revision_history(self, history):
1979
"""Factored out of set_revision_history.
1981
This performs the actual writing to disk, with format-specific checks.
1982
It is intended to be called by BzrBranch5.set_revision_history.
1984
if len(history) == 0:
1985
last_revision = 'null:'
1987
if history != self._lefthand_history(history[-1]):
1988
raise errors.NotLefthandHistory(history)
1989
last_revision = history[-1]
1990
if self._get_append_revisions_only():
1991
self._check_history_violation(last_revision)
1992
self._write_last_revision_info(len(history), last_revision)
1995
def _set_parent_location(self, url):
1996
"""Set the parent branch"""
1997
self._set_config_location('parent_location', url, make_relative=True)
2000
def _get_parent_location(self):
2001
"""Set the parent branch"""
2002
return self._get_config_location('parent_location')
2004
def set_push_location(self, location):
2005
"""See Branch.set_push_location."""
2006
self._set_config_location('push_location', location)
2008
def set_bound_location(self, location):
2009
"""See Branch.set_push_location."""
2011
config = self.get_config()
2012
if location is None:
2013
if config.get_user_option('bound') != 'True':
2016
config.set_user_option('bound', 'False', warn_masked=True)
2019
self._set_config_location('bound_location', location,
2021
config.set_user_option('bound', 'True', warn_masked=True)
2024
def _get_bound_location(self, bound):
2025
"""Return the bound location in the config file.
2027
Return None if the bound parameter does not match"""
2028
config = self.get_config()
2029
config_bound = (config.get_user_option('bound') == 'True')
2030
if config_bound != bound:
2032
return self._get_config_location('bound_location', config=config)
2034
def get_bound_location(self):
2035
"""See Branch.set_push_location."""
2036
return self._get_bound_location(True)
2038
def get_old_bound_location(self):
2039
"""See Branch.get_old_bound_location"""
2040
return self._get_bound_location(False)
2042
def set_append_revisions_only(self, enabled):
2047
self.get_config().set_user_option('append_revisions_only', value,
2050
def _get_append_revisions_only(self):
2051
value = self.get_config().get_user_option('append_revisions_only')
2052
return value == 'True'
2054
def _synchronize_history(self, destination, revision_id):
2055
"""Synchronize last revision and revision history between branches.
2057
This version is most efficient when the destination is also a
2058
BzrBranch6, but works for BzrBranch5, as long as the destination's
2059
repository contains all the lefthand ancestors of the intended
2060
last_revision. If not, set_last_revision_info will fail.
2062
:param destination: The branch to copy the history into
2063
:param revision_id: The revision-id to truncate history at. May
2064
be None to copy complete history.
2066
source_revno, source_revision_id = self.last_revision_info()
2067
if revision_id is None:
2068
revno, revision_id = source_revno, source_revision_id
2069
elif source_revision_id == revision_id:
2070
# we know the revno without needing to walk all of history
2071
revno = source_revno
2073
# To figure out the revno for a random revision, we need to build
2074
# the revision history, and count its length.
2075
# We don't care about the order, just how long it is.
2076
# Alternatively, we could start at the current location, and count
2077
# backwards. But there is no guarantee that we will find it since
2078
# it may be a merged revision.
2079
revno = len(list(self.repository.iter_reverse_revision_history(
2081
destination.set_last_revision_info(revno, revision_id)
2083
def _make_tags(self):
2084
return BasicTags(self)
2087
def generate_revision_history(self, revision_id, last_rev=None,
2089
"""See BzrBranch5.generate_revision_history"""
2090
history = self._lefthand_history(revision_id, last_rev, other_branch)
2091
revno = len(history)
2092
self.set_last_revision_info(revno, revision_id)
2095
def get_rev_id(self, revno, history=None):
2096
"""Find the revision id of the specified revno."""
2098
return _mod_revision.NULL_REVISION
2100
last_revno, last_revision_id = self.last_revision_info()
2101
if revno <= 0 or revno > last_revno:
2102
raise errors.NoSuchRevision(self, revno)
2104
if history is not None:
2105
return history[revno - 1]
2107
index = last_revno - revno
2108
if len(self._partial_revision_history_cache) <= index:
2109
self._extend_partial_history(stop_index=index)
2110
if len(self._partial_revision_history_cache) > index:
2111
return self._partial_revision_history_cache[index]
2113
raise errors.NoSuchRevision(self, revno)
2116
def revision_id_to_revno(self, revision_id):
2117
"""Given a revision id, return its revno"""
2118
if _mod_revision.is_null(revision_id):
2121
index = self._partial_revision_history_cache.index(revision_id)
2123
self._extend_partial_history(stop_revision=revision_id)
2124
index = len(self._partial_revision_history_cache) - 1
2125
if self._partial_revision_history_cache[index] != revision_id:
2126
raise errors.NoSuchRevision(self, revision_id)
2127
return self.revno() - index
2130
######################################################################
2131
# results of operations
2134
class _Result(object):
2136
def _show_tag_conficts(self, to_file):
2137
if not getattr(self, 'tag_conflicts', None):
2139
to_file.write('Conflicting tags:\n')
2140
for name, value1, value2 in self.tag_conflicts:
2141
to_file.write(' %s\n' % (name, ))
2144
class PullResult(_Result):
2145
"""Result of a Branch.pull operation.
2147
:ivar old_revno: Revision number before pull.
2148
:ivar new_revno: Revision number after pull.
2149
:ivar old_revid: Tip revision id before pull.
2150
:ivar new_revid: Tip revision id after pull.
2151
:ivar source_branch: Source (local) branch object.
2152
:ivar master_branch: Master branch of the target, or the target if no
2154
:ivar local_branch: target branch if there is a Master, else None
2155
:ivar target_branch: Target/destination branch object.
2156
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2160
# DEPRECATED: pull used to return the change in revno
2161
return self.new_revno - self.old_revno
2163
def report(self, to_file):
2165
if self.old_revid == self.new_revid:
2166
to_file.write('No revisions to pull.\n')
2168
to_file.write('Now on revision %d.\n' % self.new_revno)
2169
self._show_tag_conficts(to_file)
2172
class PushResult(_Result):
2173
"""Result of a Branch.push operation.
2175
:ivar old_revno: Revision number before push.
2176
:ivar new_revno: Revision number after push.
2177
:ivar old_revid: Tip revision id before push.
2178
:ivar new_revid: Tip revision id after push.
2179
:ivar source_branch: Source branch object.
2180
:ivar master_branch: Master branch of the target, or None.
2181
:ivar target_branch: Target/destination branch object.
2185
# DEPRECATED: push used to return the change in revno
2186
return self.new_revno - self.old_revno
2188
def report(self, to_file):
2189
"""Write a human-readable description of the result."""
2190
if self.old_revid == self.new_revid:
2191
to_file.write('No new revisions to push.\n')
2193
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2194
self._show_tag_conficts(to_file)
2197
class BranchCheckResult(object):
2198
"""Results of checking branch consistency.
2203
def __init__(self, branch):
2204
self.branch = branch
2206
def report_results(self, verbose):
2207
"""Report the check results via trace.note.
2209
:param verbose: Requests more detailed display of what was checked,
2212
note('checked branch %s format %s',
2214
self.branch._format)
2217
class Converter5to6(object):
2218
"""Perform an in-place upgrade of format 5 to format 6"""
2220
def convert(self, branch):
2221
# Data for 5 and 6 can peacefully coexist.
2222
format = BzrBranchFormat6()
2223
new_branch = format.open(branch.bzrdir, _found=True)
2225
# Copy source data into target
2226
new_branch._write_last_revision_info(*branch.last_revision_info())
2227
new_branch.set_parent(branch.get_parent())
2228
new_branch.set_bound_location(branch.get_bound_location())
2229
new_branch.set_push_location(branch.get_push_location())
2231
# New branch has no tags by default
2232
new_branch.tags._set_tag_dict({})
2234
# Copying done; now update target format
2235
new_branch._transport.put_bytes('format',
2236
format.get_format_string(),
2237
mode=new_branch.bzrdir._get_file_mode())
2239
# Clean up old files
2240
new_branch._transport.delete('revision-history')
2242
branch.set_parent(None)
2243
except errors.NoSuchFile:
2245
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
