« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 2481.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 2481.1.1
- Committer: Robert Collins
- Date: 2007-05-07 16:48:14 UTC
- mto: This revision was merged to the branch mainline in revision 2485.
- Revision ID: robertc@robertcollins.net-20070507164814-wpagonutf4b5cf8s
Move HACKING to docs/developers/HACKING and adjust Makefile to accomodate this.
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/benchmarks/tree_creator
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- bzrlib/repofmt
- bzrlib/smart
- bzrlib/store
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/intertree_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/per_lock
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/tree_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/version_info_formats
- contrib/emacs
- doc/developers
- man1
- tools/doc_generate
- tools/win32
- files removed:
- build-api
- notes
- patches
- plugins/changeset
- urlgrabber
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
#
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.
7
7
#
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.
12
12
#
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
16
16
17
17
18
import sys, os
18
from cStringIO import StringIO
19
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
19
25
20
26
import bzrlib
27
from bzrlib import (
28
bzrdir,
29
cache_utf8,
30
config as _mod_config,
31
errors,
32
lockdir,
33
lockable_files,
34
osutils,
35
revision as _mod_revision,
36
transport,
37
tree,
38
tsort,
39
ui,
40
urlutils,
41
)
42
from bzrlib.config import BranchConfig, TreeConfig
43
from bzrlib.lockable_files import LockableFiles, TransportLock
44
from bzrlib.tag import (
45
BasicTags,
46
DisabledTags,
47
)
48
""")
49
50
from bzrlib.decorators import needs_read_lock, needs_write_lock
51
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
52
HistoryMissing, InvalidRevisionId,
53
InvalidRevisionNumber, LockError, NoSuchFile,
54
NoSuchRevision, NoWorkingTree, NotVersionedError,
55
NotBranchError, UninitializableFormat,
56
UnlistableStore, UnlistableBranch,
57
)
58
from bzrlib.hooks import Hooks
59
from bzrlib.symbol_versioning import (deprecated_function,
60
deprecated_method,
61
DEPRECATED_PARAMETER,
62
deprecated_passed,
63
zero_eight, zero_nine, zero_sixteen,
64
)
21
65
from bzrlib.trace import mutter, note
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
25
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
## TODO: Maybe include checks for common corruption of newlines, etc?
28
29
30
31
def find_branch(f, **args):
32
if f and (f.startswith('http://') or f.startswith('https://')):
33
import remotebranch
34
return remotebranch.RemoteBranch(f, **args)
35
else:
36
return Branch(f, **args)
37
38
39
def find_cached_branch(f, cache_root, **args):
40
from remotebranch import RemoteBranch
41
br = find_branch(f, **args)
42
def cacheify(br, store_name):
43
from meta_store import CachedStore
44
cache_path = os.path.join(cache_root, store_name)
45
os.mkdir(cache_path)
46
new_store = CachedStore(getattr(br, store_name), cache_path)
47
setattr(br, store_name, new_store)
48
49
if isinstance(br, RemoteBranch):
50
cacheify(br, 'inventory_store')
51
cacheify(br, 'text_store')
52
cacheify(br, 'revision_store')
53
return br
54
55
56
def _relpath(base, path):
57
"""Return path relative to base, or raise exception.
58
59
The path may be either an absolute path or a path relative to the
60
current working directory.
61
62
Lifted out of Branch.relpath for ease of testing.
63
64
os.path.commonprefix (python2.4) has a bad bug that it works just
65
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
66
avoids that problem."""
67
rp = os.path.abspath(path)
68
69
s = []
70
head = rp
71
while len(head) >= len(base):
72
if head == base:
73
break
74
head, tail = os.path.split(head)
75
if tail:
76
s.insert(0, tail)
77
else:
78
from errors import NotBranchError
79
raise NotBranchError("path %r is not within branch %r" % (rp, base))
80
81
return os.sep.join(s)
82
83
84
def find_branch_root(f=None):
85
"""Find the branch root enclosing f, or pwd.
86
87
f may be a filename or a URL.
88
89
It is not necessary that f exists.
90
91
Basically we keep looking up until we find the control directory or
92
run into the root."""
93
if f == None:
94
f = os.getcwd()
95
elif hasattr(os.path, 'realpath'):
96
f = os.path.realpath(f)
97
else:
98
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
101
102
103
orig_f = f
104
105
while True:
106
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
107
return f
108
head, tail = os.path.split(f)
109
if head == f:
110
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
112
f = head
113
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
Exception.__init__(self, "These branches have diverged.")
119
120
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
123
self.branch = branch
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
66
67
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
72
73
# TODO: Maybe include checks for common corruption of newlines, etc?
74
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
127
80
128
81
129
82
######################################################################
133
86
"""Branch holding a history of revisions.
134
87
135
88
base
136
Base directory of the branch.
137
138
_lock_mode
139
None, or 'r' or 'w'
140
141
_lock_count
142
If _lock_mode is true, a positive count of the number of times the
143
lock has been taken.
144
145
_lock
146
Lock object from bzrlib.lock.
89
Base directory/url of the branch.
90
91
hooks: An instance of BranchHooks.
147
92
"""
93
# this is really an instance variable - FIXME move it there
94
# - RBC 20060112
148
95
base = None
149
_lock_mode = None
150
_lock_count = None
151
_lock = None
152
153
# Map some sort of prefix into a namespace
154
# stuff like "revno:10", "revid:", etc.
155
# This should match a prefix with a function which accepts
156
REVISION_NAMESPACES = {}
157
158
def __init__(self, base, init=False, find_root=True):
159
"""Create new branch object at a particular location.
160
161
base -- Base directory for the branch.
162
163
init -- If True, create new control files in a previously
164
unversioned directory. If False, the branch must already
165
be versioned.
166
167
find_root -- If true and init is false, find the root of the
168
existing branch containing base.
169
170
In the test suite, creation of new trees is tested using the
171
`ScratchBranch` class.
172
"""
173
from bzrlib.store import ImmutableStore
174
if init:
175
self.base = os.path.realpath(base)
176
self._make_control()
177
elif find_root:
178
self.base = find_branch_root(base)
179
else:
180
self.base = os.path.realpath(base)
181
if not isdir(self.controlfilename('.')):
182
from errors import NotBranchError
183
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
184
['use "bzr init" to initialize a new working tree',
185
'current bzr can only operate from top-of-tree'])
186
self._check_format()
187
188
self.text_store = ImmutableStore(self.controlfilename('text-store'))
189
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
190
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
191
192
193
def __str__(self):
194
return '%s(%r)' % (self.__class__.__name__, self.base)
195
196
197
__repr__ = __str__
198
199
200
def __del__(self):
201
if self._lock_mode or self._lock:
202
from warnings import warn
203
warn("branch %r was not explicitly unlocked" % self)
204
self._lock.unlock()
205
206
96
97
# override this to set the strategy for storing tags
98
def _make_tags(self):
99
return DisabledTags(self)
100
101
def __init__(self, *ignored, **ignored_too):
102
self.tags = self._make_tags()
103
self._revision_history_cache = None
104
self._revision_id_to_revno_cache = None
105
106
def break_lock(self):
107
"""Break a lock if one is present from another instance.
108
109
Uses the ui factory to ask for confirmation if the lock may be from
110
an active process.
111
112
This will probe the repository for its lock as well.
113
"""
114
self.control_files.break_lock()
115
self.repository.break_lock()
116
master = self.get_master_branch()
117
if master is not None:
118
master.break_lock()
119
120
@staticmethod
121
@deprecated_method(zero_eight)
122
def open_downlevel(base):
123
"""Open a branch which may be of an old format."""
124
return Branch.open(base, _unsupported=True)
125
126
@staticmethod
127
def open(base, _unsupported=False):
128
"""Open the branch rooted at base.
129
130
For instance, if the branch is at URL/.bzr/branch,
131
Branch.open(URL) -> a Branch instance.
132
"""
133
control = bzrdir.BzrDir.open(base, _unsupported)
134
return control.open_branch(_unsupported)
135
136
@staticmethod
137
def open_containing(url):
138
"""Open an existing branch which contains url.
139
140
This probes for a branch at url, and searches upwards from there.
141
142
Basically we keep looking up until we find the control directory or
143
run into the root. If there isn't one, raises NotBranchError.
144
If there is one and it is either an unrecognised format or an unsupported
145
format, UnknownFormatError or UnsupportedFormatError are raised.
146
If there is one, it is returned, along with the unused portion of url.
147
"""
148
control, relpath = bzrdir.BzrDir.open_containing(url)
149
return control.open_branch(), relpath
150
151
@staticmethod
152
@deprecated_function(zero_eight)
153
def initialize(base):
154
"""Create a new working tree and branch, rooted at 'base' (url)
155
156
NOTE: This will soon be deprecated in favour of creation
157
through a BzrDir.
158
"""
159
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
160
161
@deprecated_function(zero_eight)
162
def setup_caching(self, cache_root):
163
"""Subclasses that care about caching should override this, and set
164
up cached stores located under cache_root.
165
166
NOTE: This is unused.
167
"""
168
pass
169
170
def get_config(self):
171
return BranchConfig(self)
172
173
def _get_nick(self):
174
return self.get_config().get_nickname()
175
176
def _set_nick(self, nick):
177
self.get_config().set_user_option('nickname', nick)
178
179
nick = property(_get_nick, _set_nick)
180
181
def is_locked(self):
182
raise NotImplementedError(self.is_locked)
207
183
208
184
def lock_write(self):
209
if self._lock_mode:
210
if self._lock_mode != 'w':
211
from errors import LockError
212
raise LockError("can't upgrade to a write lock from %r" %
213
self._lock_mode)
214
self._lock_count += 1
215
else:
216
from bzrlib.lock import WriteLock
217
218
self._lock = WriteLock(self.controlfilename('branch-lock'))
219
self._lock_mode = 'w'
220
self._lock_count = 1
221
222
185
raise NotImplementedError(self.lock_write)
223
186
224
187
def lock_read(self):
225
if self._lock_mode:
226
assert self._lock_mode in ('r', 'w'), \
227
"invalid lock mode %r" % self._lock_mode
228
self._lock_count += 1
229
else:
230
from bzrlib.lock import ReadLock
231
232
self._lock = ReadLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'r'
234
self._lock_count = 1
235
236
237
188
raise NotImplementedError(self.lock_read)
189
238
190
def unlock(self):
239
if not self._lock_mode:
240
from errors import LockError
241
raise LockError('branch %r is not locked' % (self))
242
243
if self._lock_count > 1:
244
self._lock_count -= 1
191
raise NotImplementedError(self.unlock)
192
193
def peek_lock_mode(self):
194
"""Return lock mode for the Branch: 'r', 'w' or None"""
195
raise NotImplementedError(self.peek_lock_mode)
196
197
def get_physical_lock_status(self):
198
raise NotImplementedError(self.get_physical_lock_status)
199
200
@needs_read_lock
201
def get_revision_id_to_revno_map(self):
202
"""Return the revision_id => dotted revno map.
203
204
This will be regenerated on demand, but will be cached.
205
206
:return: A dictionary mapping revision_id => dotted revno.
207
This dictionary should not be modified by the caller.
208
"""
209
if self._revision_id_to_revno_cache is not None:
210
mapping = self._revision_id_to_revno_cache
245
211
else:
246
self._lock.unlock()
247
self._lock = None
248
self._lock_mode = self._lock_count = None
249
212
mapping = self._gen_revno_map()
213
self._cache_revision_id_to_revno(mapping)
214
# TODO: jam 20070417 Since this is being cached, should we be returning
215
# a copy?
216
# I would rather not, and instead just declare that users should not
217
# modify the return value.
218
return mapping
219
220
def _gen_revno_map(self):
221
"""Create a new mapping from revision ids to dotted revnos.
222
223
Dotted revnos are generated based on the current tip in the revision
224
history.
225
This is the worker function for get_revision_id_to_revno_map, which
226
just caches the return value.
227
228
:return: A dictionary mapping revision_id => dotted revno.
229
"""
230
last_revision = self.last_revision()
231
revision_graph = self.repository.get_revision_graph(last_revision)
232
merge_sorted_revisions = tsort.merge_sort(
233
revision_graph,
234
last_revision,
235
None,
236
generate_revno=True)
237
revision_id_to_revno = dict((rev_id, revno)
238
for seq_num, rev_id, depth, revno, end_of_merge
239
in merge_sorted_revisions)
240
return revision_id_to_revno
241
242
def leave_lock_in_place(self):
243
"""Tell this branch object not to release the physical lock when this
244
object is unlocked.
245
246
If lock_write doesn't return a token, then this method is not supported.
247
"""
248
self.control_files.leave_in_place()
249
250
def dont_leave_lock_in_place(self):
251
"""Tell this branch object to release the physical lock when this
252
object is unlocked, even if it didn't originally acquire it.
253
254
If lock_write doesn't return a token, then this method is not supported.
255
"""
256
self.control_files.dont_leave_in_place()
250
257
251
258
def abspath(self, name):
252
"""Return absolute filename for something in the branch"""
253
return os.path.join(self.base, name)
254
255
256
def relpath(self, path):
257
"""Return path relative to this branch of something inside it.
258
259
Raises an error if path is not in this branch."""
260
return _relpath(self.base, path)
261
262
263
def controlfilename(self, file_or_path):
264
"""Return location relative to branch."""
265
if isinstance(file_or_path, basestring):
266
file_or_path = [file_or_path]
267
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
268
269
270
def controlfile(self, file_or_path, mode='r'):
271
"""Open a control file for this branch.
272
273
There are two classes of file in the control directory: text
274
and binary. binary files are untranslated byte streams. Text
275
control files are stored with Unix newlines and in UTF-8, even
276
if the platform or locale defaults are different.
277
278
Controlfiles should almost never be opened in write mode but
279
rather should be atomically copied and replaced using atomicfile.
280
"""
281
282
fn = self.controlfilename(file_or_path)
283
284
if mode == 'rb' or mode == 'wb':
285
return file(fn, mode)
286
elif mode == 'r' or mode == 'w':
287
# open in binary mode anyhow so there's no newline translation;
288
# codecs uses line buffering by default; don't want that.
289
import codecs
290
return codecs.open(fn, mode + 'b', 'utf-8',
291
buffering=60000)
259
"""Return absolute filename for something in the branch
260
261
XXX: Robert Collins 20051017 what is this used for? why is it a branch
262
method and not a tree method.
263
"""
264
raise NotImplementedError(self.abspath)
265
266
def bind(self, other):
267
"""Bind the local branch the other branch.
268
269
:param other: The branch to bind to
270
:type other: Branch
271
"""
272
raise errors.UpgradeRequired(self.base)
273
274
@needs_write_lock
275
def fetch(self, from_branch, last_revision=None, pb=None):
276
"""Copy revisions from from_branch into this branch.
277
278
:param from_branch: Where to copy from.
279
:param last_revision: What revision to stop at (None for at the end
280
of the branch.
281
:param pb: An optional progress bar to use.
282
283
Returns the copied revision count and the failed revisions in a tuple:
284
(copied, failures).
285
"""
286
if self.base == from_branch.base:
287
return (0, [])
288
if pb is None:
289
nested_pb = ui.ui_factory.nested_progress_bar()
290
pb = nested_pb
292
291
else:
293
raise BzrError("invalid controlfile mode %r" % mode)
294
295
296
297
def _make_control(self):
298
from bzrlib.inventory import Inventory
299
from bzrlib.xml import pack_xml
300
301
os.mkdir(self.controlfilename([]))
302
self.controlfile('README', 'w').write(
303
"This is a Bazaar-NG control directory.\n"
304
"Do not change any files in this directory.\n")
305
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
306
for d in ('text-store', 'inventory-store', 'revision-store'):
307
os.mkdir(self.controlfilename(d))
308
for f in ('revision-history', 'merged-patches',
309
'pending-merged-patches', 'branch-name',
310
'branch-lock',
311
'pending-merges'):
312
self.controlfile(f, 'w').write('')
313
mutter('created control directory in ' + self.base)
314
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
316
317
318
def _check_format(self):
319
"""Check this branch format is supported.
320
321
The current tool only supports the current unstable format.
322
323
In the future, we might need different in-memory Branch
324
classes to support downlevel branches. But not yet.
325
"""
326
# This ignores newlines so that we can open branches created
327
# on Windows from Linux and so on. I think it might be better
328
# to always make all internal files in unix format.
329
fmt = self.controlfile('branch-format', 'r').read()
330
fmt.replace('\r\n', '')
331
if fmt != BZR_BRANCH_FORMAT:
332
raise BzrError('sorry, branch format %r not supported' % fmt,
333
['use a different bzr version',
334
'or remove the .bzr directory and "bzr init" again'])
335
292
nested_pb = None
293
294
from_branch.lock_read()
295
try:
296
if last_revision is None:
297
pb.update('get source history')
298
last_revision = from_branch.last_revision()
299
if last_revision is None:
300
last_revision = _mod_revision.NULL_REVISION
301
return self.repository.fetch(from_branch.repository,
302
revision_id=last_revision,
303
pb=nested_pb)
304
finally:
305
if nested_pb is not None:
306
nested_pb.finished()
307
from_branch.unlock()
308
309
def get_bound_location(self):
310
"""Return the URL of the branch we are bound to.
311
312
Older format branches cannot bind, please be sure to use a metadir
313
branch.
314
"""
315
return None
316
317
def get_old_bound_location(self):
318
"""Return the URL of the branch we used to be bound to
319
"""
320
raise errors.UpgradeRequired(self.base)
321
322
def get_commit_builder(self, parents, config=None, timestamp=None,
323
timezone=None, committer=None, revprops=None,
324
revision_id=None):
325
"""Obtain a CommitBuilder for this branch.
326
327
:param parents: Revision ids of the parents of the new revision.
328
:param config: Optional configuration to use.
329
:param timestamp: Optional timestamp recorded for commit.
330
:param timezone: Optional timezone for timestamp.
331
:param committer: Optional committer to set for commit.
332
:param revprops: Optional dictionary of revision properties.
333
:param revision_id: Optional revision id.
334
"""
335
336
if config is None:
337
config = self.get_config()
338
339
return self.repository.get_commit_builder(self, parents, config,
340
timestamp, timezone, committer, revprops, revision_id)
341
342
def get_master_branch(self):
343
"""Return the branch we are bound to.
344
345
:return: Either a Branch, or None
346
"""
347
return None
348
349
def get_revision_delta(self, revno):
350
"""Return the delta for one revision.
351
352
The delta is relative to its mainline predecessor, or the
353
empty tree for revision 1.
354
"""
355
assert isinstance(revno, int)
356
rh = self.revision_history()
357
if not (1 <= revno <= len(rh)):
358
raise InvalidRevisionNumber(revno)
359
return self.repository.get_revision_delta(rh[revno-1])
360
361
@deprecated_method(zero_sixteen)
336
362
def get_root_id(self):
337
"""Return the id of this branches root"""
338
inv = self.read_working_inventory()
339
return inv.root.file_id
340
341
def set_root_id(self, file_id):
342
inv = self.read_working_inventory()
343
orig_root_id = inv.root.file_id
344
del inv._byid[inv.root.file_id]
345
inv.root.file_id = file_id
346
inv._byid[inv.root.file_id] = inv.root
347
for fid in inv:
348
entry = inv[fid]
349
if entry.parent_id in (None, orig_root_id):
350
entry.parent_id = inv.root.file_id
351
self._write_inventory(inv)
352
353
def read_working_inventory(self):
354
"""Read the working inventory."""
355
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
358
before = time()
359
self.lock_read()
360
try:
361
# ElementTree does its own conversion from UTF-8, so open in
362
# binary.
363
inv = unpack_xml(Inventory,
364
self.controlfile('inventory', 'rb'))
365
mutter("loaded inventory of %d items in %f"
366
% (len(inv), time() - before))
367
return inv
368
finally:
369
self.unlock()
370
371
372
def _write_inventory(self, inv):
373
"""Update the working inventory.
374
375
That is to say, the inventory describing changes underway, that
376
will be committed to the next revision.
377
"""
378
from bzrlib.atomicfile import AtomicFile
379
from bzrlib.xml import pack_xml
380
381
self.lock_write()
382
try:
383
f = AtomicFile(self.controlfilename('inventory'), 'wb')
384
try:
385
pack_xml(inv, f)
386
f.commit()
387
finally:
388
f.close()
389
finally:
390
self.unlock()
391
392
mutter('wrote working inventory')
393
394
395
inventory = property(read_working_inventory, _write_inventory, None,
396
"""Inventory for the working copy.""")
397
398
399
def add(self, files, verbose=False, ids=None):
400
"""Make files versioned.
401
402
Note that the command line normally calls smart_add instead.
403
404
This puts the files in the Added state, so that they will be
405
recorded by the next commit.
406
407
files
408
List of paths to add, relative to the base of the tree.
409
410
ids
411
If set, use these instead of automatically generated ids.
412
Must be the same length as the list of files, but may
413
contain None for ids that are to be autogenerated.
414
415
TODO: Perhaps have an option to add the ids even if the files do
416
not (yet) exist.
417
418
TODO: Perhaps return the ids of the files? But then again it
419
is easy to retrieve them if they're needed.
420
421
TODO: Adding a directory should optionally recurse down and
422
add all non-ignored children. Perhaps do that in a
423
higher-level method.
424
"""
425
from bzrlib.textui import show_status
426
# TODO: Re-adding a file that is removed in the working copy
427
# should probably put it back with the previous ID.
428
if isinstance(files, basestring):
429
assert(ids is None or isinstance(ids, basestring))
430
files = [files]
431
if ids is not None:
432
ids = [ids]
433
434
if ids is None:
435
ids = [None] * len(files)
436
else:
437
assert(len(ids) == len(files))
438
439
self.lock_write()
440
try:
441
inv = self.read_working_inventory()
442
for f,file_id in zip(files, ids):
443
if is_control_file(f):
444
raise BzrError("cannot add control file %s" % quotefn(f))
445
446
fp = splitpath(f)
447
448
if len(fp) == 0:
449
raise BzrError("cannot add top-level %r" % f)
450
451
fullpath = os.path.normpath(self.abspath(f))
452
453
try:
454
kind = file_kind(fullpath)
455
except OSError:
456
# maybe something better?
457
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
458
459
if kind != 'file' and kind != 'directory':
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if file_id is None:
463
file_id = gen_file_id(f)
464
inv.add_path(f, kind=kind, file_id=file_id)
465
466
if verbose:
467
print 'added', quotefn(f)
468
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
470
471
self._write_inventory(inv)
472
finally:
473
self.unlock()
474
475
476
def print_file(self, file, revno):
363
"""Return the id of this branches root
364
365
Deprecated: branches don't have root ids-- trees do.
366
Use basis_tree().get_root_id() instead.
367
"""
368
raise NotImplementedError(self.get_root_id)
369
370
def print_file(self, file, revision_id):
477
371
"""Print `file` to stdout."""
478
self.lock_read()
479
try:
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
483
if not file_id:
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
486
finally:
487
self.unlock()
488
489
490
def remove(self, files, verbose=False):
491
"""Mark nominated files for removal from the inventory.
492
493
This does not remove their text. This does not run on
494
495
TODO: Refuse to remove modified files unless --force is given?
496
497
TODO: Do something useful with directories.
498
499
TODO: Should this remove the text or not? Tough call; not
500
removing may be useful and the user can just use use rm, and
501
is the opposite of add. Removing it is consistent with most
502
other tools. Maybe an option.
503
"""
504
from bzrlib.textui import show_status
505
## TODO: Normalize names
506
## TODO: Remove nested loops; better scalability
507
if isinstance(files, basestring):
508
files = [files]
509
510
self.lock_write()
511
512
try:
513
tree = self.working_tree()
514
inv = tree.inventory
515
516
# do this before any modifications
517
for f in files:
518
fid = inv.path2id(f)
519
if not fid:
520
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
521
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
522
if verbose:
523
# having remove it, it must be either ignored or unknown
524
if tree.is_ignored(f):
525
new_status = 'I'
526
else:
527
new_status = '?'
528
show_status(new_status, inv[fid].kind, quotefn(f))
529
del inv[fid]
530
531
self._write_inventory(inv)
532
finally:
533
self.unlock()
534
535
536
# FIXME: this doesn't need to be a branch method
537
def set_inventory(self, new_inventory_list):
538
from bzrlib.inventory import Inventory, InventoryEntry
539
inv = Inventory(self.get_root_id())
540
for path, file_id, parent, kind in new_inventory_list:
541
name = os.path.basename(path)
542
if name == "":
543
continue
544
inv.add(InventoryEntry(file_id, name, kind, parent))
545
self._write_inventory(inv)
546
547
548
def unknowns(self):
549
"""Return all unknown files.
550
551
These are files in the working directory that are not versioned or
552
control files or ignored.
553
554
>>> b = ScratchBranch(files=['foo', 'foo~'])
555
>>> list(b.unknowns())
556
['foo']
557
>>> b.add('foo')
558
>>> list(b.unknowns())
559
[]
560
>>> b.remove('foo')
561
>>> list(b.unknowns())
562
['foo']
563
"""
564
return self.working_tree().unknowns()
565
372
raise NotImplementedError(self.print_file)
566
373
567
374
def append_revision(self, *revision_ids):
568
from bzrlib.atomicfile import AtomicFile
569
570
for revision_id in revision_ids:
571
mutter("add {%s} to revision-history" % revision_id)
572
573
rev_history = self.revision_history()
574
rev_history.extend(revision_ids)
575
576
f = AtomicFile(self.controlfilename('revision-history'))
577
try:
578
for rev_id in rev_history:
579
print >>f, rev_id
580
f.commit()
581
finally:
582
f.close()
583
584
585
def get_revision(self, revision_id):
586
"""Return the Revision object for a named revision"""
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
589
590
self.lock_read()
591
try:
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise ValueError('invalid revision-id: %r' % revision_id)
594
r = unpack_xml(Revision, self.revision_store[revision_id])
595
finally:
596
self.unlock()
597
598
assert r.revision_id == revision_id
599
return r
600
601
602
def get_revision_sha1(self, revision_id):
603
"""Hash the stored value of a revision, and return it."""
604
# In the future, revision entries will be signed. At that
605
# point, it is probably best *not* to include the signature
606
# in the revision hash. Because that lets you re-sign
607
# the revision, (add signatures/remove signatures) and still
608
# have all hash pointers stay consistent.
609
# But for now, just hash the contents.
610
return sha_file(self.revision_store[revision_id])
611
612
613
def get_inventory(self, inventory_id):
614
"""Get Inventory object by hash.
615
616
TODO: Perhaps for this and similar methods, take a revision
617
parameter which can be either an integer revno or a
618
string hash."""
619
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
621
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
623
624
625
def get_inventory_sha1(self, inventory_id):
626
"""Return the sha1 hash of the inventory entry
627
"""
628
return sha_file(self.inventory_store[inventory_id])
629
630
631
def get_revision_inventory(self, revision_id):
632
"""Return inventory of a past revision."""
633
# bzr 0.0.6 imposes the constraint that the inventory_id
634
# must be the same as its revision, so this is trivial.
635
if revision_id == None:
636
from bzrlib.inventory import Inventory
637
return Inventory(self.get_root_id())
638
else:
639
return self.get_inventory(revision_id)
640
641
375
raise NotImplementedError(self.append_revision)
376
377
def set_revision_history(self, rev_history):
378
raise NotImplementedError(self.set_revision_history)
379
380
def _cache_revision_history(self, rev_history):
381
"""Set the cached revision history to rev_history.
382
383
The revision_history method will use this cache to avoid regenerating
384
the revision history.
385
386
This API is semi-public; it only for use by subclasses, all other code
387
should consider it to be private.
388
"""
389
self._revision_history_cache = rev_history
390
391
def _cache_revision_id_to_revno(self, revision_id_to_revno):
392
"""Set the cached revision_id => revno map to revision_id_to_revno.
393
394
This API is semi-public; it only for use by subclasses, all other code
395
should consider it to be private.
396
"""
397
self._revision_id_to_revno_cache = revision_id_to_revno
398
399
def _clear_cached_state(self):
400
"""Clear any cached data on this branch, e.g. cached revision history.
401
402
This means the next call to revision_history will need to call
403
_gen_revision_history.
404
405
This API is semi-public; it only for use by subclasses, all other code
406
should consider it to be private.
407
"""
408
self._revision_history_cache = None
409
self._revision_id_to_revno_cache = None
410
411
def _gen_revision_history(self):
412
"""Return sequence of revision hashes on to this branch.
413
414
Unlike revision_history, this method always regenerates or rereads the
415
revision history, i.e. it does not cache the result, so repeated calls
416
may be expensive.
417
418
Concrete subclasses should override this instead of revision_history so
419
that subclasses do not need to deal with caching logic.
420
421
This API is semi-public; it only for use by subclasses, all other code
422
should consider it to be private.
423
"""
424
raise NotImplementedError(self._gen_revision_history)
425
426
@needs_read_lock
642
427
def revision_history(self):
643
428
"""Return sequence of revision hashes on to this branch.
644
645
>>> ScratchBranch().revision_history()
646
[]
647
"""
648
self.lock_read()
649
try:
650
return [l.rstrip('\r\n') for l in
651
self.controlfile('revision-history', 'r').readlines()]
652
finally:
653
self.unlock()
654
655
656
def common_ancestor(self, other, self_revno=None, other_revno=None):
657
"""
658
>>> import commit
659
>>> sb = ScratchBranch(files=['foo', 'foo~'])
660
>>> sb.common_ancestor(sb) == (None, None)
661
True
662
>>> commit.commit(sb, "Committing first revision", verbose=False)
663
>>> sb.common_ancestor(sb)[0]
664
1
665
>>> clone = sb.clone()
666
>>> commit.commit(sb, "Committing second revision", verbose=False)
667
>>> sb.common_ancestor(sb)[0]
668
2
669
>>> sb.common_ancestor(clone)[0]
670
1
671
>>> commit.commit(clone, "Committing divergent second revision",
672
... verbose=False)
673
>>> sb.common_ancestor(clone)[0]
674
1
675
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
676
True
677
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
678
True
679
>>> clone2 = sb.clone()
680
>>> sb.common_ancestor(clone2)[0]
681
2
682
>>> sb.common_ancestor(clone2, self_revno=1)[0]
683
1
684
>>> sb.common_ancestor(clone2, other_revno=1)[0]
685
1
686
"""
687
my_history = self.revision_history()
688
other_history = other.revision_history()
689
if self_revno is None:
690
self_revno = len(my_history)
691
if other_revno is None:
692
other_revno = len(other_history)
693
indices = range(min((self_revno, other_revno)))
694
indices.reverse()
695
for r in indices:
696
if my_history[r] == other_history[r]:
697
return r+1, my_history[r]
698
return None, None
699
700
def enum_history(self, direction):
701
"""Return (revno, revision_id) for history of branch.
702
703
direction
704
'forward' is from earliest to latest
705
'reverse' is from latest to earliest
706
"""
707
rh = self.revision_history()
708
if direction == 'forward':
709
i = 1
710
for rid in rh:
711
yield i, rid
712
i += 1
713
elif direction == 'reverse':
714
i = len(rh)
715
while i > 0:
716
yield i, rh[i-1]
717
i -= 1
429
430
This method will cache the revision history for as long as it is safe to
431
do so.
432
"""
433
if self._revision_history_cache is not None:
434
history = self._revision_history_cache
718
435
else:
719
raise ValueError('invalid history direction', direction)
720
436
history = self._gen_revision_history()
437
self._cache_revision_history(history)
438
return list(history)
721
439
722
440
def revno(self):
723
441
"""Return current revision number for this branch.
727
445
"""
728
446
return len(self.revision_history())
729
447
730
731
def last_patch(self):
732
"""Return last patch hash, or None if no history.
733
"""
448
def unbind(self):
449
"""Older format branches cannot bind or unbind."""
450
raise errors.UpgradeRequired(self.base)
451
452
def set_append_revisions_only(self, enabled):
453
"""Older format branches are never restricted to append-only"""
454
raise errors.UpgradeRequired(self.base)
455
456
def last_revision(self):
457
"""Return last revision id, or None"""
734
458
ph = self.revision_history()
735
459
if ph:
736
460
return ph[-1]
737
461
else:
738
462
return None
739
463
464
def last_revision_info(self):
465
"""Return information about the last revision.
466
467
:return: A tuple (revno, last_revision_id).
468
"""
469
rh = self.revision_history()
470
revno = len(rh)
471
if revno:
472
return (revno, rh[-1])
473
else:
474
return (0, _mod_revision.NULL_REVISION)
740
475
741
476
def missing_revisions(self, other, stop_revision=None):
742
"""
477
"""Return a list of new revisions that would perfectly fit.
478
743
479
If self and other have not diverged, return a list of the revisions
744
480
present in other, but missing from self.
745
746
>>> from bzrlib.commit import commit
747
>>> bzrlib.trace.silent = True
748
>>> br1 = ScratchBranch()
749
>>> br2 = ScratchBranch()
750
>>> br1.missing_revisions(br2)
751
[]
752
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
753
>>> br1.missing_revisions(br2)
754
[u'REVISION-ID-1']
755
>>> br2.missing_revisions(br1)
756
[]
757
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
758
>>> br1.missing_revisions(br2)
759
[]
760
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
761
>>> br1.missing_revisions(br2)
762
[u'REVISION-ID-2A']
763
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
764
>>> br1.missing_revisions(br2)
765
Traceback (most recent call last):
766
DivergedBranches: These branches have diverged.
767
481
"""
768
482
self_history = self.revision_history()
769
483
self_len = len(self_history)
776
490
777
491
if stop_revision is None:
778
492
stop_revision = other_len
779
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
781
493
else:
494
assert isinstance(stop_revision, int)
495
if stop_revision > other_len:
496
raise errors.NoSuchRevision(self, stop_revision)
782
497
return other_history[self_len:stop_revision]
783
498
784
785
499
def update_revisions(self, other, stop_revision=None):
786
"""Pull in all new revisions from other branch.
787
788
>>> from bzrlib.commit import commit
789
>>> bzrlib.trace.silent = True
790
>>> br1 = ScratchBranch(files=['foo', 'bar'])
791
>>> br1.add('foo')
792
>>> br1.add('bar')
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
794
>>> br2 = ScratchBranch()
795
>>> br2.update_revisions(br1)
796
Added 2 texts.
797
Added 1 inventories.
798
Added 1 revisions.
799
>>> br2.revision_history()
800
[u'REVISION-ID-1']
801
>>> br2.update_revisions(br1)
802
Added 0 texts.
803
Added 0 inventories.
804
Added 0 revisions.
805
>>> br1.text_store.total_size() == br2.text_store.total_size()
806
True
807
"""
808
from bzrlib.progress import ProgressBar
809
810
pb = ProgressBar()
811
812
pb.update('comparing histories')
813
revision_ids = self.missing_revisions(other, stop_revision)
814
815
if hasattr(other.revision_store, "prefetch"):
816
other.revision_store.prefetch(revision_ids)
817
if hasattr(other.inventory_store, "prefetch"):
818
inventory_ids = [other.get_revision(r).inventory_id
819
for r in revision_ids]
820
other.inventory_store.prefetch(inventory_ids)
821
822
revisions = []
823
needed_texts = set()
824
i = 0
825
for rev_id in revision_ids:
826
i += 1
827
pb.update('fetching revision', i, len(revision_ids))
828
rev = other.get_revision(rev_id)
829
revisions.append(rev)
830
inv = other.get_inventory(str(rev.inventory_id))
831
for key, entry in inv.iter_entries():
832
if entry.text_id is None:
833
continue
834
if entry.text_id not in self.text_store:
835
needed_texts.add(entry.text_id)
836
837
pb.clear()
838
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
841
inventory_ids = [ f.inventory_id for f in revisions ]
842
count = self.inventory_store.copy_multi(other.inventory_store,
843
inventory_ids)
844
print "Added %d inventories." % count
845
revision_ids = [ f.revision_id for f in revisions]
846
count = self.revision_store.copy_multi(other.revision_store,
847
revision_ids)
848
for revision_id in revision_ids:
849
self.append_revision(revision_id)
850
print "Added %d revisions." % count
851
852
853
def commit(self, *args, **kw):
854
from bzrlib.commit import commit
855
commit(self, *args, **kw)
856
857
858
def lookup_revision(self, revision):
859
"""Return the revision identifier for a given revision information."""
860
revno, info = self.get_revision_info(revision)
861
return info
862
863
def get_revision_info(self, revision):
864
"""Return (revno, revision id) for revision identifier.
865
866
revision can be an integer, in which case it is assumed to be revno (though
867
this will translate negative values into positive ones)
868
revision can also be a string, in which case it is parsed for something like
869
'date:' or 'revid:' etc.
870
"""
871
if revision is None:
872
return 0, None
873
revno = None
874
try:# Convert to int if possible
875
revision = int(revision)
876
except ValueError:
877
pass
878
revs = self.revision_history()
879
if isinstance(revision, int):
880
if revision == 0:
881
return 0, None
882
# Mabye we should do this first, but we don't need it if revision == 0
883
if revision < 0:
884
revno = len(revs) + revision + 1
885
else:
886
revno = revision
887
elif isinstance(revision, basestring):
888
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
889
if revision.startswith(prefix):
890
revno = func(self, revs, revision)
891
break
892
else:
893
raise BzrError('No namespace registered for string: %r' % revision)
894
895
if revno is None or revno <= 0 or revno > len(revs):
896
raise BzrError("no such revision %s" % revision)
897
return revno, revs[revno-1]
898
899
def _namespace_revno(self, revs, revision):
900
"""Lookup a revision by revision number"""
901
assert revision.startswith('revno:')
902
try:
903
return int(revision[6:])
904
except ValueError:
905
return None
906
REVISION_NAMESPACES['revno:'] = _namespace_revno
907
908
def _namespace_revid(self, revs, revision):
909
assert revision.startswith('revid:')
910
try:
911
return revs.index(revision[6:]) + 1
912
except ValueError:
913
return None
914
REVISION_NAMESPACES['revid:'] = _namespace_revid
915
916
def _namespace_last(self, revs, revision):
917
assert revision.startswith('last:')
918
try:
919
offset = int(revision[5:])
920
except ValueError:
921
return None
922
else:
923
if offset <= 0:
924
raise BzrError('You must supply a positive value for --revision last:XXX')
925
return len(revs) - offset + 1
926
REVISION_NAMESPACES['last:'] = _namespace_last
927
928
def _namespace_tag(self, revs, revision):
929
assert revision.startswith('tag:')
930
raise BzrError('tag: namespace registered, but not implemented.')
931
REVISION_NAMESPACES['tag:'] = _namespace_tag
932
933
def _namespace_date(self, revs, revision):
934
assert revision.startswith('date:')
935
import datetime
936
# Spec for date revisions:
937
# date:value
938
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
939
# it can also start with a '+/-/='. '+' says match the first
940
# entry after the given date. '-' is match the first entry before the date
941
# '=' is match the first entry after, but still on the given date.
942
#
943
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
944
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
945
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
946
# May 13th, 2005 at 0:00
947
#
948
# So the proper way of saying 'give me all entries for today' is:
949
# -r {date:+today}:{date:-tomorrow}
950
# The default is '=' when not supplied
951
val = revision[5:]
952
match_style = '='
953
if val[:1] in ('+', '-', '='):
954
match_style = val[:1]
955
val = val[1:]
956
957
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
958
if val.lower() == 'yesterday':
959
dt = today - datetime.timedelta(days=1)
960
elif val.lower() == 'today':
961
dt = today
962
elif val.lower() == 'tomorrow':
963
dt = today + datetime.timedelta(days=1)
964
else:
965
import re
966
# This should be done outside the function to avoid recompiling it.
967
_date_re = re.compile(
968
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
969
r'(,|T)?\s*'
970
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
971
)
972
m = _date_re.match(val)
973
if not m or (not m.group('date') and not m.group('time')):
974
raise BzrError('Invalid revision date %r' % revision)
975
976
if m.group('date'):
977
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
978
else:
979
year, month, day = today.year, today.month, today.day
980
if m.group('time'):
981
hour = int(m.group('hour'))
982
minute = int(m.group('minute'))
983
if m.group('second'):
984
second = int(m.group('second'))
985
else:
986
second = 0
987
else:
988
hour, minute, second = 0,0,0
989
990
dt = datetime.datetime(year=year, month=month, day=day,
991
hour=hour, minute=minute, second=second)
992
first = dt
993
last = None
994
reversed = False
995
if match_style == '-':
996
reversed = True
997
elif match_style == '=':
998
last = dt + datetime.timedelta(days=1)
999
1000
if reversed:
1001
for i in range(len(revs)-1, -1, -1):
1002
r = self.get_revision(revs[i])
1003
# TODO: Handle timezone.
1004
dt = datetime.datetime.fromtimestamp(r.timestamp)
1005
if first >= dt and (last is None or dt >= last):
1006
return i+1
1007
else:
1008
for i in range(len(revs)):
1009
r = self.get_revision(revs[i])
1010
# TODO: Handle timezone.
1011
dt = datetime.datetime.fromtimestamp(r.timestamp)
1012
if first <= dt and (last is None or dt <= last):
1013
return i+1
1014
REVISION_NAMESPACES['date:'] = _namespace_date
1015
1016
def revision_tree(self, revision_id):
1017
"""Return Tree for a revision on this branch.
1018
1019
`revision_id` may be None for the null revision, in which case
1020
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1022
# TODO: refactor this to use an existing revision object
1023
# so we don't need to read it in twice.
1024
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1026
else:
1027
inv = self.get_revision_inventory(revision_id)
1028
return RevisionTree(self.text_store, inv)
1029
1030
1031
def working_tree(self):
1032
"""Return a `Tree` for the working copy."""
1033
from workingtree import WorkingTree
1034
return WorkingTree(self.base, self.read_working_inventory())
1035
500
"""Pull in new perfect-fit revisions.
501
502
:param other: Another Branch to pull from
503
:param stop_revision: Updated until the given revision
504
:return: None
505
"""
506
raise NotImplementedError(self.update_revisions)
507
508
def revision_id_to_revno(self, revision_id):
509
"""Given a revision id, return its revno"""
510
if revision_id is None:
511
return 0
512
revision_id = osutils.safe_revision_id(revision_id)
513
history = self.revision_history()
514
try:
515
return history.index(revision_id) + 1
516
except ValueError:
517
raise errors.NoSuchRevision(self, revision_id)
518
519
def get_rev_id(self, revno, history=None):
520
"""Find the revision id of the specified revno."""
521
if revno == 0:
522
return None
523
if history is None:
524
history = self.revision_history()
525
if revno <= 0 or revno > len(history):
526
raise errors.NoSuchRevision(self, revno)
527
return history[revno - 1]
528
529
def pull(self, source, overwrite=False, stop_revision=None):
530
"""Mirror source into this branch.
531
532
This branch is considered to be 'local', having low latency.
533
534
:returns: PullResult instance
535
"""
536
raise NotImplementedError(self.pull)
537
538
def push(self, target, overwrite=False, stop_revision=None):
539
"""Mirror this branch into target.
540
541
This branch is considered to be 'local', having low latency.
542
"""
543
raise NotImplementedError(self.push)
1036
544
1037
545
def basis_tree(self):
1038
"""Return `Tree` object for last revision.
1039
1040
If there are no revisions yet, return an `EmptyTree`.
1041
"""
1042
from bzrlib.tree import EmptyTree, RevisionTree
1043
r = self.last_patch()
1044
if r == None:
1045
return EmptyTree(self.get_root_id())
1046
else:
1047
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1048
1049
546
"""Return `Tree` object for last revision."""
547
return self.repository.revision_tree(self.last_revision())
1050
548
1051
549
def rename_one(self, from_rel, to_rel):
1052
550
"""Rename one file.
1053
551
1054
552
This can change the directory or the filename or both.
1055
553
"""
1056
self.lock_write()
1057
try:
1058
tree = self.working_tree()
1059
inv = tree.inventory
1060
if not tree.has_filename(from_rel):
1061
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1062
if tree.has_filename(to_rel):
1063
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1064
1065
file_id = inv.path2id(from_rel)
1066
if file_id == None:
1067
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1068
1069
if inv.path2id(to_rel):
1070
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1071
1072
to_dir, to_tail = os.path.split(to_rel)
1073
to_dir_id = inv.path2id(to_dir)
1074
if to_dir_id == None and to_dir != '':
1075
raise BzrError("can't determine destination directory id for %r" % to_dir)
1076
1077
mutter("rename_one:")
1078
mutter(" file_id {%s}" % file_id)
1079
mutter(" from_rel %r" % from_rel)
1080
mutter(" to_rel %r" % to_rel)
1081
mutter(" to_dir %r" % to_dir)
1082
mutter(" to_dir_id {%s}" % to_dir_id)
1083
1084
inv.rename(file_id, to_dir_id, to_tail)
1085
1086
print "%s => %s" % (from_rel, to_rel)
1087
1088
from_abs = self.abspath(from_rel)
1089
to_abs = self.abspath(to_rel)
1090
try:
1091
os.rename(from_abs, to_abs)
1092
except OSError, e:
1093
raise BzrError("failed to rename %r to %r: %s"
1094
% (from_abs, to_abs, e[1]),
1095
["rename rolled back"])
1096
1097
self._write_inventory(inv)
1098
finally:
1099
self.unlock()
1100
554
raise NotImplementedError(self.rename_one)
1101
555
1102
556
def move(self, from_paths, to_name):
1103
557
"""Rename files.
1109
563
1110
564
Note that to_name is only the last component of the new name;
1111
565
this doesn't change the directory.
1112
"""
1113
self.lock_write()
1114
try:
1115
## TODO: Option to move IDs only
1116
assert not isinstance(from_paths, basestring)
1117
tree = self.working_tree()
1118
inv = tree.inventory
1119
to_abs = self.abspath(to_name)
1120
if not isdir(to_abs):
1121
raise BzrError("destination %r is not a directory" % to_abs)
1122
if not tree.has_filename(to_name):
1123
raise BzrError("destination %r not in working directory" % to_abs)
1124
to_dir_id = inv.path2id(to_name)
1125
if to_dir_id == None and to_name != '':
1126
raise BzrError("destination %r is not a versioned directory" % to_name)
1127
to_dir_ie = inv[to_dir_id]
1128
if to_dir_ie.kind not in ('directory', 'root_directory'):
1129
raise BzrError("destination %r is not a directory" % to_abs)
1130
1131
to_idpath = inv.get_idpath(to_dir_id)
1132
1133
for f in from_paths:
1134
if not tree.has_filename(f):
1135
raise BzrError("%r does not exist in working tree" % f)
1136
f_id = inv.path2id(f)
1137
if f_id == None:
1138
raise BzrError("%r is not versioned" % f)
1139
name_tail = splitpath(f)[-1]
1140
dest_path = appendpath(to_name, name_tail)
1141
if tree.has_filename(dest_path):
1142
raise BzrError("destination %r already exists" % dest_path)
1143
if f_id in to_idpath:
1144
raise BzrError("can't move %r to a subdirectory of itself" % f)
1145
1146
# OK, so there's a race here, it's possible that someone will
1147
# create a file in this interval and then the rename might be
1148
# left half-done. But we should have caught most problems.
1149
1150
for f in from_paths:
1151
name_tail = splitpath(f)[-1]
1152
dest_path = appendpath(to_name, name_tail)
1153
print "%s => %s" % (f, dest_path)
1154
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1155
try:
1156
os.rename(self.abspath(f), self.abspath(dest_path))
1157
except OSError, e:
1158
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1159
["rename rolled back"])
1160
1161
self._write_inventory(inv)
1162
finally:
1163
self.unlock()
1164
1165
1166
def revert(self, filenames, old_tree=None, backups=True):
1167
"""Restore selected files to the versions from a previous tree.
1168
1169
backups
1170
If true (default) backups are made of files before
1171
they're renamed.
1172
"""
1173
from bzrlib.errors import NotVersionedError, BzrError
1174
from bzrlib.atomicfile import AtomicFile
1175
from bzrlib.osutils import backup_file
1176
1177
inv = self.read_working_inventory()
1178
if old_tree is None:
1179
old_tree = self.basis_tree()
1180
old_inv = old_tree.inventory
1181
1182
nids = []
1183
for fn in filenames:
1184
file_id = inv.path2id(fn)
1185
if not file_id:
1186
raise NotVersionedError("not a versioned file", fn)
1187
if not old_inv.has_id(file_id):
1188
raise BzrError("file not present in old tree", fn, file_id)
1189
nids.append((fn, file_id))
1190
1191
# TODO: Rename back if it was previously at a different location
1192
1193
# TODO: If given a directory, restore the entire contents from
1194
# the previous version.
1195
1196
# TODO: Make a backup to a temporary file.
1197
1198
# TODO: If the file previously didn't exist, delete it?
1199
for fn, file_id in nids:
1200
backup_file(fn)
1201
1202
f = AtomicFile(fn, 'wb')
1203
try:
1204
f.write(old_tree.get_file(file_id).read())
1205
f.commit()
1206
finally:
1207
f.close()
1208
1209
1210
def pending_merges(self):
1211
"""Return a list of pending merges.
1212
1213
These are revisions that have been merged into the working
1214
directory but not yet committed.
1215
"""
1216
cfn = self.controlfilename('pending-merges')
1217
if not os.path.exists(cfn):
1218
return []
1219
p = []
1220
for l in self.controlfile('pending-merges', 'r').readlines():
1221
p.append(l.rstrip('\n'))
1222
return p
1223
1224
1225
def add_pending_merge(self, revision_id):
1226
from bzrlib.revision import validate_revision_id
1227
1228
validate_revision_id(revision_id)
1229
1230
p = self.pending_merges()
1231
if revision_id in p:
1232
return
1233
p.append(revision_id)
1234
self.set_pending_merges(p)
1235
1236
1237
def set_pending_merges(self, rev_list):
1238
from bzrlib.atomicfile import AtomicFile
1239
self.lock_write()
1240
try:
1241
f = AtomicFile(self.controlfilename('pending-merges'))
1242
try:
1243
for l in rev_list:
1244
print >>f, l
1245
f.commit()
1246
finally:
1247
f.close()
1248
finally:
1249
self.unlock()
1250
1251
1252
1253
class ScratchBranch(Branch):
1254
"""Special test class: a branch that cleans up after itself.
1255
1256
>>> b = ScratchBranch()
1257
>>> isdir(b.base)
1258
True
1259
>>> bd = b.base
1260
>>> b.destroy()
1261
>>> isdir(bd)
1262
False
1263
"""
1264
def __init__(self, files=[], dirs=[], base=None):
1265
"""Make a test branch.
1266
1267
This creates a temporary directory and runs init-tree in it.
1268
1269
If any files are listed, they are created in the working copy.
1270
"""
1271
from tempfile import mkdtemp
1272
init = False
1273
if base is None:
1274
base = mkdtemp()
1275
init = True
1276
Branch.__init__(self, base, init=init)
1277
for d in dirs:
1278
os.mkdir(self.abspath(d))
1279
1280
for f in files:
1281
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1282
1283
1284
def clone(self):
1285
"""
1286
>>> orig = ScratchBranch(files=["file1", "file2"])
1287
>>> clone = orig.clone()
1288
>>> os.path.samefile(orig.base, clone.base)
1289
False
1290
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1291
True
1292
"""
1293
from shutil import copytree
1294
from tempfile import mkdtemp
1295
base = mkdtemp()
1296
os.rmdir(base)
1297
copytree(self.base, base, symlinks=True)
1298
return ScratchBranch(base=base)
1299
1300
def __del__(self):
1301
self.destroy()
1302
1303
def destroy(self):
1304
"""Destroy the test branch, removing the scratch directory."""
1305
from shutil import rmtree
1306
try:
1307
if self.base:
1308
mutter("delete ScratchBranch %s" % self.base)
1309
rmtree(self.base)
1310
except OSError, e:
1311
# Work around for shutil.rmtree failing on Windows when
1312
# readonly files are encountered
1313
mutter("hit exception in destroying ScratchBranch: %s" % e)
1314
for root, dirs, files in os.walk(self.base, topdown=False):
1315
for name in files:
1316
os.chmod(os.path.join(root, name), 0700)
1317
rmtree(self.base)
1318
self.base = None
1319
1320
1321
1322
######################################################################
1323
# predicates
1324
1325
1326
def is_control_file(filename):
1327
## FIXME: better check
1328
filename = os.path.normpath(filename)
1329
while filename != '':
1330
head, tail = os.path.split(filename)
1331
## mutter('check %r for control file' % ((head, tail), ))
1332
if tail == bzrlib.BZRDIR:
566
567
This returns a list of (from_path, to_path) pairs for each
568
entry that is moved.
569
"""
570
raise NotImplementedError(self.move)
571
572
def get_parent(self):
573
"""Return the parent location of the branch.
574
575
This is the default location for push/pull/missing. The usual
576
pattern is that the user can override it by specifying a
577
location.
578
"""
579
raise NotImplementedError(self.get_parent)
580
581
def _set_config_location(self, name, url, config=None,
582
make_relative=False):
583
if config is None:
584
config = self.get_config()
585
if url is None:
586
url = ''
587
elif make_relative:
588
url = urlutils.relative_url(self.base, url)
589
config.set_user_option(name, url)
590
591
def _get_config_location(self, name, config=None):
592
if config is None:
593
config = self.get_config()
594
location = config.get_user_option(name)
595
if location == '':
596
location = None
597
return location
598
599
def get_submit_branch(self):
600
"""Return the submit location of the branch.
601
602
This is the default location for bundle. The usual
603
pattern is that the user can override it by specifying a
604
location.
605
"""
606
return self.get_config().get_user_option('submit_branch')
607
608
def set_submit_branch(self, location):
609
"""Return the submit location of the branch.
610
611
This is the default location for bundle. The usual
612
pattern is that the user can override it by specifying a
613
location.
614
"""
615
self.get_config().set_user_option('submit_branch', location)
616
617
def get_public_branch(self):
618
"""Return the public location of the branch.
619
620
This is is used by merge directives.
621
"""
622
return self._get_config_location('public_branch')
623
624
def set_public_branch(self, location):
625
"""Return the submit location of the branch.
626
627
This is the default location for bundle. The usual
628
pattern is that the user can override it by specifying a
629
location.
630
"""
631
self._set_config_location('public_branch', location)
632
633
def get_push_location(self):
634
"""Return the None or the location to push this branch to."""
635
push_loc = self.get_config().get_user_option('push_location')
636
return push_loc
637
638
def set_push_location(self, location):
639
"""Set a new push location for this branch."""
640
raise NotImplementedError(self.set_push_location)
641
642
def set_parent(self, url):
643
raise NotImplementedError(self.set_parent)
644
645
@needs_write_lock
646
def update(self):
647
"""Synchronise this branch with the master branch if any.
648
649
:return: None or the last_revision pivoted out during the update.
650
"""
651
return None
652
653
def check_revno(self, revno):
654
"""\
655
Check whether a revno corresponds to any revision.
656
Zero (the NULL revision) is considered valid.
657
"""
658
if revno != 0:
659
self.check_real_revno(revno)
660
661
def check_real_revno(self, revno):
662
"""\
663
Check whether a revno corresponds to a real revision.
664
Zero (the NULL revision) is considered invalid
665
"""
666
if revno < 1 or revno > self.revno():
667
raise InvalidRevisionNumber(revno)
668
669
@needs_read_lock
670
def clone(self, to_bzrdir, revision_id=None):
671
"""Clone this branch into to_bzrdir preserving all semantic values.
672
673
revision_id: if not None, the revision history in the new branch will
674
be truncated to end with revision_id.
675
"""
676
result = self._format.initialize(to_bzrdir)
677
self.copy_content_into(result, revision_id=revision_id)
678
return result
679
680
@needs_read_lock
681
def sprout(self, to_bzrdir, revision_id=None):
682
"""Create a new line of development from the branch, into to_bzrdir.
683
684
revision_id: if not None, the revision history in the new branch will
685
be truncated to end with revision_id.
686
"""
687
result = self._format.initialize(to_bzrdir)
688
self.copy_content_into(result, revision_id=revision_id)
689
result.set_parent(self.bzrdir.root_transport.base)
690
return result
691
692
def _synchronize_history(self, destination, revision_id):
693
"""Synchronize last revision and revision history between branches.
694
695
This version is most efficient when the destination is also a
696
BzrBranch5, but works for BzrBranch6 as long as the revision
697
history is the true lefthand parent history, and all of the revisions
698
are in the destination's repository. If not, set_revision_history
699
will fail.
700
701
:param destination: The branch to copy the history into
702
:param revision_id: The revision-id to truncate history at. May
703
be None to copy complete history.
704
"""
705
new_history = self.revision_history()
706
if revision_id is not None:
707
revision_id = osutils.safe_revision_id(revision_id)
708
try:
709
new_history = new_history[:new_history.index(revision_id) + 1]
710
except ValueError:
711
rev = self.repository.get_revision(revision_id)
712
new_history = rev.get_history(self.repository)[1:]
713
destination.set_revision_history(new_history)
714
715
@needs_read_lock
716
def copy_content_into(self, destination, revision_id=None):
717
"""Copy the content of self into destination.
718
719
revision_id: if not None, the revision history in the new branch will
720
be truncated to end with revision_id.
721
"""
722
self._synchronize_history(destination, revision_id)
723
try:
724
parent = self.get_parent()
725
except errors.InaccessibleParent, e:
726
mutter('parent was not accessible to copy: %s', e)
727
else:
728
if parent:
729
destination.set_parent(parent)
730
self.tags.merge_to(destination.tags)
731
732
@needs_read_lock
733
def check(self):
734
"""Check consistency of the branch.
735
736
In particular this checks that revisions given in the revision-history
737
do actually match up in the revision graph, and that they're all
738
present in the repository.
739
740
Callers will typically also want to check the repository.
741
742
:return: A BranchCheckResult.
743
"""
744
mainline_parent_id = None
745
for revision_id in self.revision_history():
746
try:
747
revision = self.repository.get_revision(revision_id)
748
except errors.NoSuchRevision, e:
749
raise errors.BzrCheckError("mainline revision {%s} not in repository"
750
% revision_id)
751
# In general the first entry on the revision history has no parents.
752
# But it's not illegal for it to have parents listed; this can happen
753
# in imports from Arch when the parents weren't reachable.
754
if mainline_parent_id is not None:
755
if mainline_parent_id not in revision.parent_ids:
756
raise errors.BzrCheckError("previous revision {%s} not listed among "
757
"parents of {%s}"
758
% (mainline_parent_id, revision_id))
759
mainline_parent_id = revision_id
760
return BranchCheckResult(self)
761
762
def _get_checkout_format(self):
763
"""Return the most suitable metadir for a checkout of this branch.
764
Weaves are used if this branch's repository uses weaves.
765
"""
766
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
767
from bzrlib.repofmt import weaverepo
768
format = bzrdir.BzrDirMetaFormat1()
769
format.repository_format = weaverepo.RepositoryFormat7()
770
else:
771
format = self.repository.bzrdir.checkout_metadir()
772
format.set_branch_format(self._format)
773
return format
774
775
def create_checkout(self, to_location, revision_id=None,
776
lightweight=False):
777
"""Create a checkout of a branch.
778
779
:param to_location: The url to produce the checkout at
780
:param revision_id: The revision to check out
781
:param lightweight: If True, produce a lightweight checkout, otherwise,
782
produce a bound branch (heavyweight checkout)
783
:return: The tree of the created checkout
784
"""
785
t = transport.get_transport(to_location)
786
t.ensure_base()
787
if lightweight:
788
format = self._get_checkout_format()
789
checkout = format.initialize_on_transport(t)
790
BranchReferenceFormat().initialize(checkout, self)
791
else:
792
format = self._get_checkout_format()
793
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
794
to_location, force_new_tree=False, format=format)
795
checkout = checkout_branch.bzrdir
796
checkout_branch.bind(self)
797
# pull up to the specified revision_id to set the initial
798
# branch tip correctly, and seed it with history.
799
checkout_branch.pull(self, stop_revision=revision_id)
800
tree = checkout.create_workingtree(revision_id)
801
basis_tree = tree.basis_tree()
802
basis_tree.lock_read()
803
try:
804
for path, file_id in basis_tree.iter_references():
805
reference_parent = self.reference_parent(file_id, path)
806
reference_parent.create_checkout(tree.abspath(path),
807
basis_tree.get_reference_revision(file_id, path),
808
lightweight)
809
finally:
810
basis_tree.unlock()
811
return tree
812
813
def reference_parent(self, file_id, path):
814
"""Return the parent branch for a tree-reference file_id
815
:param file_id: The file_id of the tree reference
816
:param path: The path of the file_id in the tree
817
:return: A branch associated with the file_id
818
"""
819
# FIXME should provide multiple branches, based on config
820
return Branch.open(self.bzrdir.root_transport.clone(path).base)
821
822
def supports_tags(self):
823
return self._format.supports_tags()
824
825
826
class BranchFormat(object):
827
"""An encapsulation of the initialization and open routines for a format.
828
829
Formats provide three things:
830
* An initialization routine,
831
* a format string,
832
* an open routine.
833
834
Formats are placed in an dict by their format string for reference
835
during branch opening. Its not required that these be instances, they
836
can be classes themselves with class methods - it simply depends on
837
whether state is needed for a given format or not.
838
839
Once a format is deprecated, just deprecate the initialize and open
840
methods on the format class. Do not deprecate the object, as the
841
object will be created every time regardless.
842
"""
843
844
_default_format = None
845
"""The default format used for new branches."""
846
847
_formats = {}
848
"""The known formats."""
849
850
@classmethod
851
def find_format(klass, a_bzrdir):
852
"""Return the format for the branch object in a_bzrdir."""
853
try:
854
transport = a_bzrdir.get_branch_transport(None)
855
format_string = transport.get("format").read()
856
return klass._formats[format_string]
857
except NoSuchFile:
858
raise NotBranchError(path=transport.base)
859
except KeyError:
860
raise errors.UnknownFormatError(format=format_string)
861
862
@classmethod
863
def get_default_format(klass):
864
"""Return the current default format."""
865
return klass._default_format
866
867
def get_reference(self, a_bzrdir):
868
"""Get the target reference of the branch in a_bzrdir.
869
870
format probing must have been completed before calling
871
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
873
874
:param a_bzrdir: The bzrdir to get the branch data from.
875
:return: None if the branch is not a reference branch.
876
"""
877
return None
878
879
def get_format_string(self):
880
"""Return the ASCII format string that identifies this format."""
881
raise NotImplementedError(self.get_format_string)
882
883
def get_format_description(self):
884
"""Return the short format description for this format."""
885
raise NotImplementedError(self.get_format_description)
886
887
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
888
set_format=True):
889
"""Initialize a branch in a bzrdir, with specified files
890
891
:param a_bzrdir: The bzrdir to initialize the branch in
892
:param utf8_files: The files to create as a list of
893
(filename, content) tuples
894
:param set_format: If True, set the format with
895
self.get_format_string. (BzrBranch4 has its format set
896
elsewhere)
897
:return: a branch in this format
898
"""
899
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
branch_transport = a_bzrdir.get_branch_transport(self)
901
lock_map = {
902
'metadir': ('lock', lockdir.LockDir),
903
'branch4': ('branch-lock', lockable_files.TransportLock),
904
}
905
lock_name, lock_class = lock_map[lock_type]
906
control_files = lockable_files.LockableFiles(branch_transport,
907
lock_name, lock_class)
908
control_files.create_lock()
909
control_files.lock_write()
910
if set_format:
911
control_files.put_utf8('format', self.get_format_string())
912
try:
913
for file, content in utf8_files:
914
control_files.put_utf8(file, content)
915
finally:
916
control_files.unlock()
917
return self.open(a_bzrdir, _found=True)
918
919
def initialize(self, a_bzrdir):
920
"""Create a branch of this format in a_bzrdir."""
921
raise NotImplementedError(self.initialize)
922
923
def is_supported(self):
924
"""Is this format supported?
925
926
Supported formats can be initialized and opened.
927
Unsupported formats may not support initialization or committing or
928
some other features depending on the reason for not being supported.
929
"""
930
return True
931
932
def open(self, a_bzrdir, _found=False):
933
"""Return the branch object for a_bzrdir
934
935
_found is a private parameter, do not use it. It is used to indicate
936
if format probing has already be done.
937
"""
938
raise NotImplementedError(self.open)
939
940
@classmethod
941
def register_format(klass, format):
942
klass._formats[format.get_format_string()] = format
943
944
@classmethod
945
def set_default_format(klass, format):
946
klass._default_format = format
947
948
@classmethod
949
def unregister_format(klass, format):
950
assert klass._formats[format.get_format_string()] is format
951
del klass._formats[format.get_format_string()]
952
953
def __str__(self):
954
return self.get_format_string().rstrip()
955
956
def supports_tags(self):
957
"""True if this format supports tags stored in the branch"""
958
return False # by default
959
960
# XXX: Probably doesn't really belong here -- mbp 20070212
961
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
962
lock_class):
963
branch_transport = a_bzrdir.get_branch_transport(self)
964
control_files = lockable_files.LockableFiles(branch_transport,
965
lock_filename, lock_class)
966
control_files.create_lock()
967
control_files.lock_write()
968
try:
969
for filename, content in utf8_files:
970
control_files.put_utf8(filename, content)
971
finally:
972
control_files.unlock()
973
974
975
class BranchHooks(Hooks):
976
"""A dictionary mapping hook name to a list of callables for branch hooks.
977
978
e.g. ['set_rh'] Is the list of items to be called when the
979
set_revision_history function is invoked.
980
"""
981
982
def __init__(self):
983
"""Create the default hooks.
984
985
These are all empty initially, because by default nothing should get
986
notified.
987
"""
988
Hooks.__init__(self)
989
# Introduced in 0.15:
990
# invoked whenever the revision history has been set
991
# with set_revision_history. The api signature is
992
# (branch, revision_history), and the branch will
993
# be write-locked.
994
self['set_rh'] = []
995
# invoked after a push operation completes.
996
# the api signature is
997
# (push_result)
998
# containing the members
999
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
# where local is the local branch or None, master is the target
1001
# master branch, and the rest should be self explanatory. The source
1002
# is read locked and the target branches write locked. Source will
1003
# be the local low-latency branch.
1004
self['post_push'] = []
1005
# invoked after a pull operation completes.
1006
# the api signature is
1007
# (pull_result)
1008
# containing the members
1009
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1010
# where local is the local branch or None, master is the target
1011
# master branch, and the rest should be self explanatory. The source
1012
# is read locked and the target branches write locked. The local
1013
# branch is the low-latency branch.
1014
self['post_pull'] = []
1015
# invoked after a commit operation completes.
1016
# the api signature is
1017
# (local, master, old_revno, old_revid, new_revno, new_revid)
1018
# old_revid is NULL_REVISION for the first commit to a branch.
1019
self['post_commit'] = []
1020
# invoked after a uncommit operation completes.
1021
# the api signature is
1022
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
# local is the local branch or None, master is the target branch,
1024
# and an empty branch recieves new_revno of 0, new_revid of None.
1025
self['post_uncommit'] = []
1026
1027
1028
# install the default hooks into the Branch class.
1029
Branch.hooks = BranchHooks()
1030
1031
1032
class BzrBranchFormat4(BranchFormat):
1033
"""Bzr branch format 4.
1034
1035
This format has:
1036
- a revision-history file.
1037
- a branch-lock lock file [ to be shared with the bzrdir ]
1038
"""
1039
1040
def get_format_description(self):
1041
"""See BranchFormat.get_format_description()."""
1042
return "Branch format 4"
1043
1044
def initialize(self, a_bzrdir):
1045
"""Create a branch of this format in a_bzrdir."""
1046
utf8_files = [('revision-history', ''),
1047
('branch-name', ''),
1048
]
1049
return self._initialize_helper(a_bzrdir, utf8_files,
1050
lock_type='branch4', set_format=False)
1051
1052
def __init__(self):
1053
super(BzrBranchFormat4, self).__init__()
1054
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1055
1056
def open(self, a_bzrdir, _found=False):
1057
"""Return the branch object for a_bzrdir
1058
1059
_found is a private parameter, do not use it. It is used to indicate
1060
if format probing has already be done.
1061
"""
1062
if not _found:
1063
# we are being called directly and must probe.
1064
raise NotImplementedError
1065
return BzrBranch(_format=self,
1066
_control_files=a_bzrdir._control_files,
1067
a_bzrdir=a_bzrdir,
1068
_repository=a_bzrdir.open_repository())
1069
1070
def __str__(self):
1071
return "Bazaar-NG branch format 4"
1072
1073
1074
class BzrBranchFormat5(BranchFormat):
1075
"""Bzr branch format 5.
1076
1077
This format has:
1078
- a revision-history file.
1079
- a format string
1080
- a lock dir guarding the branch itself
1081
- all of this stored in a branch/ subdirectory
1082
- works with shared repositories.
1083
1084
This format is new in bzr 0.8.
1085
"""
1086
1087
def get_format_string(self):
1088
"""See BranchFormat.get_format_string()."""
1089
return "Bazaar-NG branch format 5\n"
1090
1091
def get_format_description(self):
1092
"""See BranchFormat.get_format_description()."""
1093
return "Branch format 5"
1094
1095
def initialize(self, a_bzrdir):
1096
"""Create a branch of this format in a_bzrdir."""
1097
utf8_files = [('revision-history', ''),
1098
('branch-name', ''),
1099
]
1100
return self._initialize_helper(a_bzrdir, utf8_files)
1101
1102
def __init__(self):
1103
super(BzrBranchFormat5, self).__init__()
1104
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1105
1106
def open(self, a_bzrdir, _found=False):
1107
"""Return the branch object for a_bzrdir
1108
1109
_found is a private parameter, do not use it. It is used to indicate
1110
if format probing has already be done.
1111
"""
1112
if not _found:
1113
format = BranchFormat.find_format(a_bzrdir)
1114
assert format.__class__ == self.__class__
1115
try:
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1118
lockdir.LockDir)
1119
return BzrBranch5(_format=self,
1120
_control_files=control_files,
1121
a_bzrdir=a_bzrdir,
1122
_repository=a_bzrdir.find_repository())
1123
except NoSuchFile:
1124
raise NotBranchError(path=transport.base)
1125
1126
1127
class BzrBranchFormat6(BzrBranchFormat5):
1128
"""Branch format with last-revision
1129
1130
Unlike previous formats, this has no explicit revision history. Instead,
1131
this just stores the last-revision, and the left-hand history leading
1132
up to there is the history.
1133
1134
This format was introduced in bzr 0.15
1135
"""
1136
1137
def get_format_string(self):
1138
"""See BranchFormat.get_format_string()."""
1139
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1140
1141
def get_format_description(self):
1142
"""See BranchFormat.get_format_description()."""
1143
return "Branch format 6"
1144
1145
def initialize(self, a_bzrdir):
1146
"""Create a branch of this format in a_bzrdir."""
1147
utf8_files = [('last-revision', '0 null:\n'),
1148
('branch-name', ''),
1149
('branch.conf', ''),
1150
('tags', ''),
1151
]
1152
return self._initialize_helper(a_bzrdir, utf8_files)
1153
1154
def open(self, a_bzrdir, _found=False):
1155
"""Return the branch object for a_bzrdir
1156
1157
_found is a private parameter, do not use it. It is used to indicate
1158
if format probing has already be done.
1159
"""
1160
if not _found:
1161
format = BranchFormat.find_format(a_bzrdir)
1162
assert format.__class__ == self.__class__
1163
transport = a_bzrdir.get_branch_transport(None)
1164
control_files = lockable_files.LockableFiles(transport, 'lock',
1165
lockdir.LockDir)
1166
return BzrBranch6(_format=self,
1167
_control_files=control_files,
1168
a_bzrdir=a_bzrdir,
1169
_repository=a_bzrdir.find_repository())
1170
1171
def supports_tags(self):
1172
return True
1173
1174
1175
class BranchReferenceFormat(BranchFormat):
1176
"""Bzr branch reference format.
1177
1178
Branch references are used in implementing checkouts, they
1179
act as an alias to the real branch which is at some other url.
1180
1181
This format has:
1182
- A location file
1183
- a format string
1184
"""
1185
1186
def get_format_string(self):
1187
"""See BranchFormat.get_format_string()."""
1188
return "Bazaar-NG Branch Reference Format 1\n"
1189
1190
def get_format_description(self):
1191
"""See BranchFormat.get_format_description()."""
1192
return "Checkout reference format 1"
1193
1194
def get_reference(self, a_bzrdir):
1195
"""See BranchFormat.get_reference()."""
1196
transport = a_bzrdir.get_branch_transport(None)
1197
return transport.get('location').read()
1198
1199
def initialize(self, a_bzrdir, target_branch=None):
1200
"""Create a branch of this format in a_bzrdir."""
1201
if target_branch is None:
1202
# this format does not implement branch itself, thus the implicit
1203
# creation contract must see it as uninitializable
1204
raise errors.UninitializableFormat(self)
1205
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1206
branch_transport = a_bzrdir.get_branch_transport(self)
1207
branch_transport.put_bytes('location',
1208
target_branch.bzrdir.root_transport.base)
1209
branch_transport.put_bytes('format', self.get_format_string())
1210
return self.open(a_bzrdir, _found=True)
1211
1212
def __init__(self):
1213
super(BranchReferenceFormat, self).__init__()
1214
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1215
1216
def _make_reference_clone_function(format, a_branch):
1217
"""Create a clone() routine for a branch dynamically."""
1218
def clone(to_bzrdir, revision_id=None):
1219
"""See Branch.clone()."""
1220
return format.initialize(to_bzrdir, a_branch)
1221
# cannot obey revision_id limits when cloning a reference ...
1222
# FIXME RBC 20060210 either nuke revision_id for clone, or
1223
# emit some sort of warning/error to the caller ?!
1224
return clone
1225
1226
def open(self, a_bzrdir, _found=False, location=None):
1227
"""Return the branch that the branch reference in a_bzrdir points at.
1228
1229
_found is a private parameter, do not use it. It is used to indicate
1230
if format probing has already be done.
1231
"""
1232
if not _found:
1233
format = BranchFormat.find_format(a_bzrdir)
1234
assert format.__class__ == self.__class__
1235
if location is None:
1236
location = self.get_reference(a_bzrdir)
1237
real_bzrdir = bzrdir.BzrDir.open(location)
1238
result = real_bzrdir.open_branch()
1239
# this changes the behaviour of result.clone to create a new reference
1240
# rather than a copy of the content of the branch.
1241
# I did not use a proxy object because that needs much more extensive
1242
# testing, and we are only changing one behaviour at the moment.
1243
# If we decide to alter more behaviours - i.e. the implicit nickname
1244
# then this should be refactored to introduce a tested proxy branch
1245
# and a subclass of that for use in overriding clone() and ....
1246
# - RBC 20060210
1247
result.clone = self._make_reference_clone_function(result)
1248
return result
1249
1250
1251
# formats which have no format string are not discoverable
1252
# and not independently creatable, so are not registered.
1253
__default_format = BzrBranchFormat5()
1254
BranchFormat.register_format(__default_format)
1255
BranchFormat.register_format(BranchReferenceFormat())
1256
BranchFormat.register_format(BzrBranchFormat6())
1257
BranchFormat.set_default_format(__default_format)
1258
_legacy_formats = [BzrBranchFormat4(),
1259
]
1260
1261
class BzrBranch(Branch):
1262
"""A branch stored in the actual filesystem.
1263
1264
Note that it's "local" in the context of the filesystem; it doesn't
1265
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1266
it's writable, and can be accessed via the normal filesystem API.
1267
"""
1268
1269
def __init__(self, _format=None,
1270
_control_files=None, a_bzrdir=None, _repository=None):
1271
"""Create new branch object at a particular location."""
1272
Branch.__init__(self)
1273
if a_bzrdir is None:
1274
raise ValueError('a_bzrdir must be supplied')
1275
else:
1276
self.bzrdir = a_bzrdir
1277
# self._transport used to point to the directory containing the
1278
# control directory, but was not used - now it's just the transport
1279
# for the branch control files. mbp 20070212
1280
self._base = self.bzrdir.transport.clone('..').base
1281
self._format = _format
1282
if _control_files is None:
1283
raise ValueError('BzrBranch _control_files is None')
1284
self.control_files = _control_files
1285
self._transport = _control_files._transport
1286
self.repository = _repository
1287
1288
def __str__(self):
1289
return '%s(%r)' % (self.__class__.__name__, self.base)
1290
1291
__repr__ = __str__
1292
1293
def _get_base(self):
1294
"""Returns the directory containing the control directory."""
1295
return self._base
1296
1297
base = property(_get_base, doc="The URL for the root of this branch.")
1298
1299
def abspath(self, name):
1300
"""See Branch.abspath."""
1301
return self.control_files._transport.abspath(name)
1302
1303
1304
@deprecated_method(zero_sixteen)
1305
@needs_read_lock
1306
def get_root_id(self):
1307
"""See Branch.get_root_id."""
1308
tree = self.repository.revision_tree(self.last_revision())
1309
return tree.inventory.root.file_id
1310
1311
def is_locked(self):
1312
return self.control_files.is_locked()
1313
1314
def lock_write(self, token=None):
1315
repo_token = self.repository.lock_write()
1316
try:
1317
token = self.control_files.lock_write(token=token)
1318
except:
1319
self.repository.unlock()
1320
raise
1321
return token
1322
1323
def lock_read(self):
1324
self.repository.lock_read()
1325
try:
1326
self.control_files.lock_read()
1327
except:
1328
self.repository.unlock()
1329
raise
1330
1331
def unlock(self):
1332
# TODO: test for failed two phase locks. This is known broken.
1333
try:
1334
self.control_files.unlock()
1335
finally:
1336
self.repository.unlock()
1337
if not self.control_files.is_locked():
1338
# we just released the lock
1339
self._clear_cached_state()
1340
1341
def peek_lock_mode(self):
1342
if self.control_files._lock_count == 0:
1343
return None
1344
else:
1345
return self.control_files._lock_mode
1346
1347
def get_physical_lock_status(self):
1348
return self.control_files.get_physical_lock_status()
1349
1350
@needs_read_lock
1351
def print_file(self, file, revision_id):
1352
"""See Branch.print_file."""
1353
return self.repository.print_file(file, revision_id)
1354
1355
@needs_write_lock
1356
def append_revision(self, *revision_ids):
1357
"""See Branch.append_revision."""
1358
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1359
for revision_id in revision_ids:
1360
_mod_revision.check_not_reserved_id(revision_id)
1361
mutter("add {%s} to revision-history" % revision_id)
1362
rev_history = self.revision_history()
1363
rev_history.extend(revision_ids)
1364
self.set_revision_history(rev_history)
1365
1366
def _write_revision_history(self, history):
1367
"""Factored out of set_revision_history.
1368
1369
This performs the actual writing to disk.
1370
It is intended to be called by BzrBranch5.set_revision_history."""
1371
self.control_files.put_bytes(
1372
'revision-history', '\n'.join(history))
1373
1374
@needs_write_lock
1375
def set_revision_history(self, rev_history):
1376
"""See Branch.set_revision_history."""
1377
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1378
self._clear_cached_state()
1379
self._write_revision_history(rev_history)
1380
self._cache_revision_history(rev_history)
1381
for hook in Branch.hooks['set_rh']:
1382
hook(self, rev_history)
1383
1384
@needs_write_lock
1385
def set_last_revision_info(self, revno, revision_id):
1386
revision_id = osutils.safe_revision_id(revision_id)
1387
history = self._lefthand_history(revision_id)
1388
assert len(history) == revno, '%d != %d' % (len(history), revno)
1389
self.set_revision_history(history)
1390
1391
def _gen_revision_history(self):
1392
history = self.control_files.get('revision-history').read().split('\n')
1393
if history[-1:] == ['']:
1394
# There shouldn't be a trailing newline, but just in case.
1395
history.pop()
1396
return history
1397
1398
def _lefthand_history(self, revision_id, last_rev=None,
1399
other_branch=None):
1400
# stop_revision must be a descendant of last_revision
1401
stop_graph = self.repository.get_revision_graph(revision_id)
1402
if last_rev is not None and last_rev not in stop_graph:
1403
# our previous tip is not merged into stop_revision
1404
raise errors.DivergedBranches(self, other_branch)
1405
# make a new revision history from the graph
1406
current_rev_id = revision_id
1407
new_history = []
1408
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1409
new_history.append(current_rev_id)
1410
current_rev_id_parents = stop_graph[current_rev_id]
1411
try:
1412
current_rev_id = current_rev_id_parents[0]
1413
except IndexError:
1414
current_rev_id = None
1415
new_history.reverse()
1416
return new_history
1417
1418
@needs_write_lock
1419
def generate_revision_history(self, revision_id, last_rev=None,
1420
other_branch=None):
1421
"""Create a new revision history that will finish with revision_id.
1422
1423
:param revision_id: the new tip to use.
1424
:param last_rev: The previous last_revision. If not None, then this
1425
must be a ancestory of revision_id, or DivergedBranches is raised.
1426
:param other_branch: The other branch that DivergedBranches should
1427
raise with respect to.
1428
"""
1429
revision_id = osutils.safe_revision_id(revision_id)
1430
self.set_revision_history(self._lefthand_history(revision_id,
1431
last_rev, other_branch))
1432
1433
@needs_write_lock
1434
def update_revisions(self, other, stop_revision=None):
1435
"""See Branch.update_revisions."""
1436
other.lock_read()
1437
try:
1438
if stop_revision is None:
1439
stop_revision = other.last_revision()
1440
if stop_revision is None:
1441
# if there are no commits, we're done.
1442
return
1443
else:
1444
stop_revision = osutils.safe_revision_id(stop_revision)
1445
# whats the current last revision, before we fetch [and change it
1446
# possibly]
1447
last_rev = self.last_revision()
1448
# we fetch here regardless of whether we need to so that we pickup
1449
# filled in ghosts.
1450
self.fetch(other, stop_revision)
1451
my_ancestry = self.repository.get_ancestry(last_rev)
1452
if stop_revision in my_ancestry:
1453
# last_revision is a descendant of stop_revision
1454
return
1455
self.generate_revision_history(stop_revision, last_rev=last_rev,
1456
other_branch=other)
1457
finally:
1458
other.unlock()
1459
1460
def basis_tree(self):
1461
"""See Branch.basis_tree."""
1462
return self.repository.revision_tree(self.last_revision())
1463
1464
@deprecated_method(zero_eight)
1465
def working_tree(self):
1466
"""Create a Working tree object for this branch."""
1467
1468
from bzrlib.transport.local import LocalTransport
1469
if (self.base.find('://') != -1 or
1470
not isinstance(self._transport, LocalTransport)):
1471
raise NoWorkingTree(self.base)
1472
return self.bzrdir.open_workingtree()
1473
1474
@needs_write_lock
1475
def pull(self, source, overwrite=False, stop_revision=None,
1476
_hook_master=None, _run_hooks=True):
1477
"""See Branch.pull.
1478
1479
:param _hook_master: Private parameter - set the branch to
1480
be supplied as the master to push hooks.
1481
:param _run_hooks: Private parameter - allow disabling of
1482
hooks, used when pushing to a master branch.
1483
"""
1484
result = PullResult()
1485
result.source_branch = source
1486
result.target_branch = self
1487
source.lock_read()
1488
try:
1489
result.old_revno, result.old_revid = self.last_revision_info()
1490
try:
1491
self.update_revisions(source, stop_revision)
1492
except DivergedBranches:
1493
if not overwrite:
1494
raise
1495
if overwrite:
1496
if stop_revision is None:
1497
stop_revision = source.last_revision()
1498
self.generate_revision_history(stop_revision)
1499
result.tag_conflicts = source.tags.merge_to(self.tags)
1500
result.new_revno, result.new_revid = self.last_revision_info()
1501
if _hook_master:
1502
result.master_branch = _hook_master
1503
result.local_branch = self
1504
else:
1505
result.master_branch = self
1506
result.local_branch = None
1507
if _run_hooks:
1508
for hook in Branch.hooks['post_pull']:
1509
hook(result)
1510
finally:
1511
source.unlock()
1512
return result
1513
1514
def _get_parent_location(self):
1515
_locs = ['parent', 'pull', 'x-pull']
1516
for l in _locs:
1517
try:
1518
return self.control_files.get(l).read().strip('\n')
1519
except NoSuchFile:
1520
pass
1521
return None
1522
1523
@needs_read_lock
1524
def push(self, target, overwrite=False, stop_revision=None,
1525
_hook_master=None, _run_hooks=True):
1526
"""See Branch.push.
1527
1528
:param _hook_master: Private parameter - set the branch to
1529
be supplied as the master to push hooks.
1530
:param _run_hooks: Private parameter - allow disabling of
1531
hooks, used when pushing to a master branch.
1532
"""
1533
result = PushResult()
1534
result.source_branch = self
1535
result.target_branch = target
1536
target.lock_write()
1537
try:
1538
result.old_revno, result.old_revid = target.last_revision_info()
1539
try:
1540
target.update_revisions(self, stop_revision)
1541
except DivergedBranches:
1542
if not overwrite:
1543
raise
1544
if overwrite:
1545
target.set_revision_history(self.revision_history())
1546
result.tag_conflicts = self.tags.merge_to(target.tags)
1547
result.new_revno, result.new_revid = target.last_revision_info()
1548
if _hook_master:
1549
result.master_branch = _hook_master
1550
result.local_branch = target
1551
else:
1552
result.master_branch = target
1553
result.local_branch = None
1554
if _run_hooks:
1555
for hook in Branch.hooks['post_push']:
1556
hook(result)
1557
finally:
1558
target.unlock()
1559
return result
1560
1561
def get_parent(self):
1562
"""See Branch.get_parent."""
1563
1564
assert self.base[-1] == '/'
1565
parent = self._get_parent_location()
1566
if parent is None:
1567
return parent
1568
# This is an old-format absolute path to a local branch
1569
# turn it into a url
1570
if parent.startswith('/'):
1571
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1572
try:
1573
return urlutils.join(self.base[:-1], parent)
1574
except errors.InvalidURLJoin, e:
1575
raise errors.InaccessibleParent(parent, self.base)
1576
1577
def set_push_location(self, location):
1578
"""See Branch.set_push_location."""
1579
self.get_config().set_user_option(
1580
'push_location', location,
1581
store=_mod_config.STORE_LOCATION_NORECURSE)
1582
1583
@needs_write_lock
1584
def set_parent(self, url):
1585
"""See Branch.set_parent."""
1586
# TODO: Maybe delete old location files?
1587
# URLs should never be unicode, even on the local fs,
1588
# FIXUP this and get_parent in a future branch format bump:
1589
# read and rewrite the file, and have the new format code read
1590
# using .get not .get_utf8. RBC 20060125
1591
if url is not None:
1592
if isinstance(url, unicode):
1593
try:
1594
url = url.encode('ascii')
1595
except UnicodeEncodeError:
1596
raise errors.InvalidURL(url,
1597
"Urls must be 7-bit ascii, "
1598
"use bzrlib.urlutils.escape")
1599
url = urlutils.relative_url(self.base, url)
1600
self._set_parent_location(url)
1601
1602
def _set_parent_location(self, url):
1603
if url is None:
1604
self.control_files._transport.delete('parent')
1605
else:
1606
assert isinstance(url, str)
1607
self.control_files.put_bytes('parent', url + '\n')
1608
1609
@deprecated_function(zero_nine)
1610
def tree_config(self):
1611
"""DEPRECATED; call get_config instead.
1612
TreeConfig has become part of BranchConfig."""
1613
return TreeConfig(self)
1614
1615
1616
class BzrBranch5(BzrBranch):
1617
"""A format 5 branch. This supports new features over plan branches.
1618
1619
It has support for a master_branch which is the data for bound branches.
1620
"""
1621
1622
def __init__(self,
1623
_format,
1624
_control_files,
1625
a_bzrdir,
1626
_repository):
1627
super(BzrBranch5, self).__init__(_format=_format,
1628
_control_files=_control_files,
1629
a_bzrdir=a_bzrdir,
1630
_repository=_repository)
1631
1632
@needs_write_lock
1633
def pull(self, source, overwrite=False, stop_revision=None,
1634
_run_hooks=True):
1635
"""Extends branch.pull to be bound branch aware.
1636
1637
:param _run_hooks: Private parameter used to force hook running
1638
off during bound branch double-pushing.
1639
"""
1640
bound_location = self.get_bound_location()
1641
master_branch = None
1642
if bound_location and source.base != bound_location:
1643
# not pulling from master, so we need to update master.
1644
master_branch = self.get_master_branch()
1645
master_branch.lock_write()
1646
try:
1647
if master_branch:
1648
# pull from source into master.
1649
master_branch.pull(source, overwrite, stop_revision,
1650
_run_hooks=False)
1651
return super(BzrBranch5, self).pull(source, overwrite,
1652
stop_revision, _hook_master=master_branch,
1653
_run_hooks=_run_hooks)
1654
finally:
1655
if master_branch:
1656
master_branch.unlock()
1657
1658
@needs_read_lock
1659
def push(self, target, overwrite=False, stop_revision=None):
1660
"""Updates branch.push to be bound branch aware."""
1661
bound_location = target.get_bound_location()
1662
master_branch = None
1663
if bound_location and target.base != bound_location:
1664
# not pushing to master, so we need to update master.
1665
master_branch = target.get_master_branch()
1666
master_branch.lock_write()
1667
try:
1668
if master_branch:
1669
# push into the master from this branch.
1670
super(BzrBranch5, self).push(master_branch, overwrite,
1671
stop_revision, _run_hooks=False)
1672
# and push into the target branch from this. Note that we push from
1673
# this branch again, because its considered the highest bandwidth
1674
# repository.
1675
return super(BzrBranch5, self).push(target, overwrite,
1676
stop_revision, _hook_master=master_branch)
1677
finally:
1678
if master_branch:
1679
master_branch.unlock()
1680
1681
def get_bound_location(self):
1682
try:
1683
return self.control_files.get_utf8('bound').read()[:-1]
1684
except errors.NoSuchFile:
1685
return None
1686
1687
@needs_read_lock
1688
def get_master_branch(self):
1689
"""Return the branch we are bound to.
1690
1691
:return: Either a Branch, or None
1692
1693
This could memoise the branch, but if thats done
1694
it must be revalidated on each new lock.
1695
So for now we just don't memoise it.
1696
# RBC 20060304 review this decision.
1697
"""
1698
bound_loc = self.get_bound_location()
1699
if not bound_loc:
1700
return None
1701
try:
1702
return Branch.open(bound_loc)
1703
except (errors.NotBranchError, errors.ConnectionError), e:
1704
raise errors.BoundBranchConnectionFailure(
1705
self, bound_loc, e)
1706
1707
@needs_write_lock
1708
def set_bound_location(self, location):
1709
"""Set the target where this branch is bound to.
1710
1711
:param location: URL to the target branch
1712
"""
1713
if location:
1714
self.control_files.put_utf8('bound', location+'\n')
1715
else:
1716
try:
1717
self.control_files._transport.delete('bound')
1718
except NoSuchFile:
1719
return False
1333
1720
return True
1334
if filename == head:
1335
break
1336
filename = head
1337
return False
1338
1339
1340
1341
def gen_file_id(name):
1342
"""Return new file id.
1343
1344
This should probably generate proper UUIDs, but for the moment we
1345
cope with just randomness because running uuidgen every time is
1346
slow."""
1347
import re
1348
from binascii import hexlify
1349
from time import time
1350
1351
# get last component
1352
idx = name.rfind('/')
1353
if idx != -1:
1354
name = name[idx+1 : ]
1355
idx = name.rfind('\\')
1356
if idx != -1:
1357
name = name[idx+1 : ]
1358
1359
# make it not a hidden file
1360
name = name.lstrip('.')
1361
1362
# remove any wierd characters; we don't escape them but rather
1363
# just pull them out
1364
name = re.sub(r'[^\w.]', '', name)
1365
1366
s = hexlify(rand_bytes(8))
1367
return '-'.join((name, compact_date(time()), s))
1368
1369
1370
def gen_root_id():
1371
"""Return a new tree-root file id."""
1372
return gen_file_id('TREE_ROOT')
1373
1721
1722
@needs_write_lock
1723
def bind(self, other):
1724
"""Bind this branch to the branch other.
1725
1726
This does not push or pull data between the branches, though it does
1727
check for divergence to raise an error when the branches are not
1728
either the same, or one a prefix of the other. That behaviour may not
1729
be useful, so that check may be removed in future.
1730
1731
:param other: The branch to bind to
1732
:type other: Branch
1733
"""
1734
# TODO: jam 20051230 Consider checking if the target is bound
1735
# It is debatable whether you should be able to bind to
1736
# a branch which is itself bound.
1737
# Committing is obviously forbidden,
1738
# but binding itself may not be.
1739
# Since we *have* to check at commit time, we don't
1740
# *need* to check here
1741
1742
# we want to raise diverged if:
1743
# last_rev is not in the other_last_rev history, AND
1744
# other_last_rev is not in our history, and do it without pulling
1745
# history around
1746
last_rev = self.last_revision()
1747
if last_rev is not None:
1748
other.lock_read()
1749
try:
1750
other_last_rev = other.last_revision()
1751
if other_last_rev is not None:
1752
# neither branch is new, we have to do some work to
1753
# ascertain diversion.
1754
remote_graph = other.repository.get_revision_graph(
1755
other_last_rev)
1756
local_graph = self.repository.get_revision_graph(last_rev)
1757
if (last_rev not in remote_graph and
1758
other_last_rev not in local_graph):
1759
raise errors.DivergedBranches(self, other)
1760
finally:
1761
other.unlock()
1762
self.set_bound_location(other.base)
1763
1764
@needs_write_lock
1765
def unbind(self):
1766
"""If bound, unbind"""
1767
return self.set_bound_location(None)
1768
1769
@needs_write_lock
1770
def update(self):
1771
"""Synchronise this branch with the master branch if any.
1772
1773
:return: None or the last_revision that was pivoted out during the
1774
update.
1775
"""
1776
master = self.get_master_branch()
1777
if master is not None:
1778
old_tip = self.last_revision()
1779
self.pull(master, overwrite=True)
1780
if old_tip in self.repository.get_ancestry(self.last_revision()):
1781
return None
1782
return old_tip
1783
return None
1784
1785
1786
class BzrBranchExperimental(BzrBranch5):
1787
"""Bzr experimental branch format
1788
1789
This format has:
1790
- a revision-history file.
1791
- a format string
1792
- a lock dir guarding the branch itself
1793
- all of this stored in a branch/ subdirectory
1794
- works with shared repositories.
1795
- a tag dictionary in the branch
1796
1797
This format is new in bzr 0.15, but shouldn't be used for real data,
1798
only for testing.
1799
1800
This class acts as it's own BranchFormat.
1801
"""
1802
1803
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1804
1805
@classmethod
1806
def get_format_string(cls):
1807
"""See BranchFormat.get_format_string()."""
1808
return "Bazaar-NG branch format experimental\n"
1809
1810
@classmethod
1811
def get_format_description(cls):
1812
"""See BranchFormat.get_format_description()."""
1813
return "Experimental branch format"
1814
1815
@classmethod
1816
def get_reference(cls, a_bzrdir):
1817
"""Get the target reference of the branch in a_bzrdir.
1818
1819
format probing must have been completed before calling
1820
this method - it is assumed that the format of the branch
1821
in a_bzrdir is correct.
1822
1823
:param a_bzrdir: The bzrdir to get the branch data from.
1824
:return: None if the branch is not a reference branch.
1825
"""
1826
return None
1827
1828
@classmethod
1829
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1830
lock_class):
1831
branch_transport = a_bzrdir.get_branch_transport(cls)
1832
control_files = lockable_files.LockableFiles(branch_transport,
1833
lock_filename, lock_class)
1834
control_files.create_lock()
1835
control_files.lock_write()
1836
try:
1837
for filename, content in utf8_files:
1838
control_files.put_utf8(filename, content)
1839
finally:
1840
control_files.unlock()
1841
1842
@classmethod
1843
def initialize(cls, a_bzrdir):
1844
"""Create a branch of this format in a_bzrdir."""
1845
utf8_files = [('format', cls.get_format_string()),
1846
('revision-history', ''),
1847
('branch-name', ''),
1848
('tags', ''),
1849
]
1850
cls._initialize_control_files(a_bzrdir, utf8_files,
1851
'lock', lockdir.LockDir)
1852
return cls.open(a_bzrdir, _found=True)
1853
1854
@classmethod
1855
def open(cls, a_bzrdir, _found=False):
1856
"""Return the branch object for a_bzrdir
1857
1858
_found is a private parameter, do not use it. It is used to indicate
1859
if format probing has already be done.
1860
"""
1861
if not _found:
1862
format = BranchFormat.find_format(a_bzrdir)
1863
assert format.__class__ == cls
1864
transport = a_bzrdir.get_branch_transport(None)
1865
control_files = lockable_files.LockableFiles(transport, 'lock',
1866
lockdir.LockDir)
1867
return cls(_format=cls,
1868
_control_files=control_files,
1869
a_bzrdir=a_bzrdir,
1870
_repository=a_bzrdir.find_repository())
1871
1872
@classmethod
1873
def is_supported(cls):
1874
return True
1875
1876
def _make_tags(self):
1877
return BasicTags(self)
1878
1879
@classmethod
1880
def supports_tags(cls):
1881
return True
1882
1883
1884
BranchFormat.register_format(BzrBranchExperimental)
1885
1886
1887
class BzrBranch6(BzrBranch5):
1888
1889
@needs_read_lock
1890
def last_revision_info(self):
1891
revision_string = self.control_files.get('last-revision').read()
1892
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1893
revision_id = cache_utf8.get_cached_utf8(revision_id)
1894
revno = int(revno)
1895
return revno, revision_id
1896
1897
def last_revision(self):
1898
"""Return last revision id, or None"""
1899
revision_id = self.last_revision_info()[1]
1900
if revision_id == _mod_revision.NULL_REVISION:
1901
revision_id = None
1902
return revision_id
1903
1904
def _write_last_revision_info(self, revno, revision_id):
1905
"""Simply write out the revision id, with no checks.
1906
1907
Use set_last_revision_info to perform this safely.
1908
1909
Does not update the revision_history cache.
1910
Intended to be called by set_last_revision_info and
1911
_write_revision_history.
1912
"""
1913
if revision_id is None:
1914
revision_id = 'null:'
1915
out_string = '%d %s\n' % (revno, revision_id)
1916
self.control_files.put_bytes('last-revision', out_string)
1917
1918
@needs_write_lock
1919
def set_last_revision_info(self, revno, revision_id):
1920
revision_id = osutils.safe_revision_id(revision_id)
1921
if self._get_append_revisions_only():
1922
self._check_history_violation(revision_id)
1923
self._write_last_revision_info(revno, revision_id)
1924
self._clear_cached_state()
1925
1926
def _check_history_violation(self, revision_id):
1927
last_revision = self.last_revision()
1928
if last_revision is None:
1929
return
1930
if last_revision not in self._lefthand_history(revision_id):
1931
raise errors.AppendRevisionsOnlyViolation(self.base)
1932
1933
def _gen_revision_history(self):
1934
"""Generate the revision history from last revision
1935
"""
1936
history = list(self.repository.iter_reverse_revision_history(
1937
self.last_revision()))
1938
history.reverse()
1939
return history
1940
1941
def _write_revision_history(self, history):
1942
"""Factored out of set_revision_history.
1943
1944
This performs the actual writing to disk, with format-specific checks.
1945
It is intended to be called by BzrBranch5.set_revision_history.
1946
"""
1947
if len(history) == 0:
1948
last_revision = 'null:'
1949
else:
1950
if history != self._lefthand_history(history[-1]):
1951
raise errors.NotLefthandHistory(history)
1952
last_revision = history[-1]
1953
if self._get_append_revisions_only():
1954
self._check_history_violation(last_revision)
1955
self._write_last_revision_info(len(history), last_revision)
1956
1957
@needs_write_lock
1958
def append_revision(self, *revision_ids):
1959
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1960
if len(revision_ids) == 0:
1961
return
1962
prev_revno, prev_revision = self.last_revision_info()
1963
for revision in self.repository.get_revisions(revision_ids):
1964
if prev_revision == _mod_revision.NULL_REVISION:
1965
if revision.parent_ids != []:
1966
raise errors.NotLeftParentDescendant(self, prev_revision,
1967
revision.revision_id)
1968
else:
1969
if revision.parent_ids[0] != prev_revision:
1970
raise errors.NotLeftParentDescendant(self, prev_revision,
1971
revision.revision_id)
1972
prev_revision = revision.revision_id
1973
self.set_last_revision_info(prev_revno + len(revision_ids),
1974
revision_ids[-1])
1975
1976
@needs_write_lock
1977
def _set_parent_location(self, url):
1978
"""Set the parent branch"""
1979
self._set_config_location('parent_location', url, make_relative=True)
1980
1981
@needs_read_lock
1982
def _get_parent_location(self):
1983
"""Set the parent branch"""
1984
return self._get_config_location('parent_location')
1985
1986
def set_push_location(self, location):
1987
"""See Branch.set_push_location."""
1988
self._set_config_location('push_location', location)
1989
1990
def set_bound_location(self, location):
1991
"""See Branch.set_push_location."""
1992
result = None
1993
config = self.get_config()
1994
if location is None:
1995
if config.get_user_option('bound') != 'True':
1996
return False
1997
else:
1998
config.set_user_option('bound', 'False')
1999
return True
2000
else:
2001
self._set_config_location('bound_location', location,
2002
config=config)
2003
config.set_user_option('bound', 'True')
2004
return True
2005
2006
def _get_bound_location(self, bound):
2007
"""Return the bound location in the config file.
2008
2009
Return None if the bound parameter does not match"""
2010
config = self.get_config()
2011
config_bound = (config.get_user_option('bound') == 'True')
2012
if config_bound != bound:
2013
return None
2014
return self._get_config_location('bound_location', config=config)
2015
2016
def get_bound_location(self):
2017
"""See Branch.set_push_location."""
2018
return self._get_bound_location(True)
2019
2020
def get_old_bound_location(self):
2021
"""See Branch.get_old_bound_location"""
2022
return self._get_bound_location(False)
2023
2024
def set_append_revisions_only(self, enabled):
2025
if enabled:
2026
value = 'True'
2027
else:
2028
value = 'False'
2029
self.get_config().set_user_option('append_revisions_only', value)
2030
2031
def _get_append_revisions_only(self):
2032
value = self.get_config().get_user_option('append_revisions_only')
2033
return value == 'True'
2034
2035
def _synchronize_history(self, destination, revision_id):
2036
"""Synchronize last revision and revision history between branches.
2037
2038
This version is most efficient when the destination is also a
2039
BzrBranch6, but works for BzrBranch5, as long as the destination's
2040
repository contains all the lefthand ancestors of the intended
2041
last_revision. If not, set_last_revision_info will fail.
2042
2043
:param destination: The branch to copy the history into
2044
:param revision_id: The revision-id to truncate history at. May
2045
be None to copy complete history.
2046
"""
2047
if revision_id is None:
2048
revno, revision_id = self.last_revision_info()
2049
else:
2050
revno = self.revision_id_to_revno(revision_id)
2051
destination.set_last_revision_info(revno, revision_id)
2052
2053
def _make_tags(self):
2054
return BasicTags(self)
2055
2056
2057
class BranchTestProviderAdapter(object):
2058
"""A tool to generate a suite testing multiple branch formats at once.
2059
2060
This is done by copying the test once for each transport and injecting
2061
the transport_server, transport_readonly_server, and branch_format
2062
classes into each copy. Each copy is also given a new id() to make it
2063
easy to identify.
2064
"""
2065
2066
def __init__(self, transport_server, transport_readonly_server, formats,
2067
vfs_transport_factory=None):
2068
self._transport_server = transport_server
2069
self._transport_readonly_server = transport_readonly_server
2070
self._formats = formats
2071
2072
def adapt(self, test):
2073
result = TestSuite()
2074
for branch_format, bzrdir_format in self._formats:
2075
new_test = deepcopy(test)
2076
new_test.transport_server = self._transport_server
2077
new_test.transport_readonly_server = self._transport_readonly_server
2078
new_test.bzrdir_format = bzrdir_format
2079
new_test.branch_format = branch_format
2080
def make_new_test_id():
2081
# the format can be either a class or an instance
2082
name = getattr(branch_format, '__name__',
2083
branch_format.__class__.__name__)
2084
new_id = "%s(%s)" % (new_test.id(), name)
2085
return lambda: new_id
2086
new_test.id = make_new_test_id()
2087
result.addTest(new_test)
2088
return result
2089
2090
2091
######################################################################
2092
# results of operations
2093
2094
2095
class _Result(object):
2096
2097
def _show_tag_conficts(self, to_file):
2098
if not getattr(self, 'tag_conflicts', None):
2099
return
2100
to_file.write('Conflicting tags:\n')
2101
for name, value1, value2 in self.tag_conflicts:
2102
to_file.write(' %s\n' % (name, ))
2103
2104
2105
class PullResult(_Result):
2106
"""Result of a Branch.pull operation.
2107
2108
:ivar old_revno: Revision number before pull.
2109
:ivar new_revno: Revision number after pull.
2110
:ivar old_revid: Tip revision id before pull.
2111
:ivar new_revid: Tip revision id after pull.
2112
:ivar source_branch: Source (local) branch object.
2113
:ivar master_branch: Master branch of the target, or None.
2114
:ivar target_branch: Target/destination branch object.
2115
"""
2116
2117
def __int__(self):
2118
# DEPRECATED: pull used to return the change in revno
2119
return self.new_revno - self.old_revno
2120
2121
def report(self, to_file):
2122
if self.old_revid == self.new_revid:
2123
to_file.write('No revisions to pull.\n')
2124
else:
2125
to_file.write('Now on revision %d.\n' % self.new_revno)
2126
self._show_tag_conficts(to_file)
2127
2128
2129
class PushResult(_Result):
2130
"""Result of a Branch.push operation.
2131
2132
:ivar old_revno: Revision number before push.
2133
:ivar new_revno: Revision number after push.
2134
:ivar old_revid: Tip revision id before push.
2135
:ivar new_revid: Tip revision id after push.
2136
:ivar source_branch: Source branch object.
2137
:ivar master_branch: Master branch of the target, or None.
2138
:ivar target_branch: Target/destination branch object.
2139
"""
2140
2141
def __int__(self):
2142
# DEPRECATED: push used to return the change in revno
2143
return self.new_revno - self.old_revno
2144
2145
def report(self, to_file):
2146
"""Write a human-readable description of the result."""
2147
if self.old_revid == self.new_revid:
2148
to_file.write('No new revisions to push.\n')
2149
else:
2150
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2151
self._show_tag_conficts(to_file)
2152
2153
2154
class BranchCheckResult(object):
2155
"""Results of checking branch consistency.
2156
2157
:see: Branch.check
2158
"""
2159
2160
def __init__(self, branch):
2161
self.branch = branch
2162
2163
def report_results(self, verbose):
2164
"""Report the check results via trace.note.
2165
2166
:param verbose: Requests more detailed display of what was checked,
2167
if any.
2168
"""
2169
note('checked branch %s format %s',
2170
self.branch.base,
2171
self.branch._format)
2172
2173
2174
class Converter5to6(object):
2175
"""Perform an in-place upgrade of format 5 to format 6"""
2176
2177
def convert(self, branch):
2178
# Data for 5 and 6 can peacefully coexist.
2179
format = BzrBranchFormat6()
2180
new_branch = format.open(branch.bzrdir, _found=True)
2181
2182
# Copy source data into target
2183
new_branch.set_last_revision_info(*branch.last_revision_info())
2184
new_branch.set_parent(branch.get_parent())
2185
new_branch.set_bound_location(branch.get_bound_location())
2186
new_branch.set_push_location(branch.get_push_location())
2187
2188
# New branch has no tags by default
2189
new_branch.tags._set_tag_dict({})
2190
2191
# Copying done; now update target format
2192
new_branch.control_files.put_utf8('format',
2193
format.get_format_string())
2194
2195
# Clean up old files
2196
new_branch.control_files._transport.delete('revision-history')
2197
try:
2198
branch.set_parent(None)
2199
except NoSuchFile:
2200
pass
2201
branch.set_bound_location(None)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1