« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1668.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1668.1.1
- Committer: Canonical.com Patch Queue Manager
- Date: 2006-05-08 03:51:23 UTC
- mfrom: (1703 +trunk)
- mto: (1704.2.14 bzr.mbp.integration) (1668.2.1 0.8)
- mto: This revision was merged to the branch mainline in revision 1710.
- Revision ID: pqm@pqm.ubuntu.com-20060508035123-aa6bac1e9ba18f94
(mbp) merge bzr.dev to 0.8, prepare for release
- files added:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- tools/doc_generate
- files removed:
- bzrlib/changeset.py
- patches
- files renamed:
- bzrlib/store/weave.py => bzrlib/store/versioned/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/testannotate.py => bzrlib/tests/blackbox/test_annotate.py
- bzrlib/selftest/test_revision_info.py => bzrlib/tests/blackbox/test_revision_info.py
- 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/test_parent.py => bzrlib/tests/branch_implementations/test_parent.py
- bzrlib/selftest/testconfig.py => bzrlib/tests/test_config.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.py
- bzrlib/selftest/testfetch.py => bzrlib/tests/test_fetch.py
- bzrlib/selftest/testgpg.py => bzrlib/tests/test_gpg.py
- bzrlib/selftest/testgraph.py => bzrlib/tests/test_graph.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testhttp.py => bzrlib/tests/test_http.py
- bzrlib/selftest/testidentitymap.py => bzrlib/tests/test_identitymap.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testlog.py => bzrlib/tests/test_log.py
- bzrlib/selftest/testmerge.py => bzrlib/tests/test_merge.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/testnonascii.py => bzrlib/tests/test_nonascii.py
- bzrlib/selftest/testoptions.py => bzrlib/tests/test_options.py
- bzrlib/selftest/testplugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevision.py => bzrlib/tests/test_revision.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- bzrlib/selftest/testrevprops.py => bzrlib/tests/test_revprops.py
- bzrlib/selftest/testsampler.py => bzrlib/tests/test_sampler.py
- bzrlib/selftest/teststore.py => bzrlib/tests/test_store.py
- bzrlib/selftest/testtestament.py => bzrlib/tests/test_testament.py
- bzrlib/selftest/testtransactions.py => bzrlib/tests/test_transactions.py
- bzrlib/selftest/testtransport.py => bzrlib/tests/test_transport.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- bzrlib/selftest/testworkingtree.py => bzrlib/tests/test_workingtree.py
- bzrlib/transport/http.py => bzrlib/transport/http/__init__.py
- bzrlib/ui.py => bzrlib/ui/__init__.py
- bzrlib/xml.py => bzrlib/xml_serializer.py
- tutorial.txt => doc/tutorial.txt
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006 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
from copy import deepcopy
19
from cStringIO import StringIO
20
import errno
21
import os
22
import shutil
18
23
import sys
19
import os
20
import errno
24
from unittest import TestSuite
21
25
from warnings import warn
22
from cStringIO import StringIO
23
24
26
25
27
import bzrlib
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
31
file_kind, abspath)
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
32
import bzrlib.errors as errors
33
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError)
35
DivergedBranches, LockError,
36
UninitializableFormat,
37
UnlistableStore,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
39
NoWorkingTree)
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
47
safe_unicode,
48
rmtree,
49
)
37
50
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
39
40
from bzrlib.delta import compare_trees
51
from bzrlib.trace import mutter, note
41
52
from bzrlib.tree import EmptyTree, RevisionTree
42
from bzrlib.inventory import Inventory
53
from bzrlib.repository import Repository
54
from bzrlib.revision import (
55
get_intervening_revisions,
56
is_ancestor,
57
NULL_REVISION,
58
Revision,
59
)
43
60
from bzrlib.store import copy_all
44
from bzrlib.store.compressed_text import CompressedTextStore
45
from bzrlib.store.text import TextStore
46
from bzrlib.store.weave import WeaveStore
47
from bzrlib.testament import Testament
61
from bzrlib.symbol_versioning import *
48
62
import bzrlib.transactions as transactions
49
63
from bzrlib.transport import Transport, get_transport
64
from bzrlib.tree import EmptyTree, RevisionTree
65
import bzrlib.ui
50
66
import bzrlib.xml5
51
import bzrlib.ui
52
67
53
68
54
69
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
55
70
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
56
71
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
57
## TODO: Maybe include checks for common corruption of newlines, etc?
58
72
73
74
# TODO: Maybe include checks for common corruption of newlines, etc?
59
75
60
76
# TODO: Some operations like log might retrieve the same revisions
61
77
# repeatedly to calculate deltas. We could perhaps have a weakref
62
78
# cache in memory to make this faster. In general anything can be
63
# cached in memory between lock and unlock operations.
64
65
def find_branch(*ignored, **ignored_too):
66
# XXX: leave this here for about one release, then remove it
67
raise NotImplementedError('find_branch() is not supported anymore, '
68
'please use one of the new branch constructors')
69
70
71
def needs_read_lock(unbound):
72
"""Decorate unbound to take out and release a read lock."""
73
def decorated(self, *args, **kwargs):
74
self.lock_read()
75
try:
76
return unbound(self, *args, **kwargs)
77
finally:
78
self.unlock()
79
return decorated
80
81
82
def needs_write_lock(unbound):
83
"""Decorate unbound to take out and release a write lock."""
84
def decorated(self, *args, **kwargs):
85
self.lock_write()
86
try:
87
return unbound(self, *args, **kwargs)
88
finally:
89
self.unlock()
90
return decorated
79
# cached in memory between lock and unlock operations. .. nb thats
80
# what the transaction identity map provides
81
91
82
92
83
######################################################################
93
84
# branch objects
98
89
base
99
90
Base directory/url of the branch.
100
91
"""
92
# this is really an instance variable - FIXME move it there
93
# - RBC 20060112
101
94
base = None
102
95
103
96
def __init__(self, *ignored, **ignored_too):
104
97
raise NotImplementedError('The Branch class is abstract')
105
98
99
def break_lock(self):
100
"""Break a lock if one is present from another instance.
101
102
Uses the ui factory to ask for confirmation if the lock may be from
103
an active process.
104
105
This will probe the repository for its lock as well.
106
"""
107
self.control_files.break_lock()
108
self.repository.break_lock()
109
master = self.get_master_branch()
110
if master is not None:
111
master.break_lock()
112
106
113
@staticmethod
114
@deprecated_method(zero_eight)
107
115
def open_downlevel(base):
108
"""Open a branch which may be of an old format.
109
110
Only local branches are supported."""
111
return _Branch(get_transport(base), relax_version_check=True)
116
"""Open a branch which may be of an old format."""
117
return Branch.open(base, _unsupported=True)
112
118
113
119
@staticmethod
114
def open(base):
115
"""Open an existing branch, rooted at 'base' (url)"""
116
t = get_transport(base)
117
mutter("trying to open %r with transport %r", base, t)
118
return _Branch(t)
120
def open(base, _unsupported=False):
121
"""Open the repository rooted at base.
122
123
For instance, if the repository is at URL/.bzr/repository,
124
Repository.open(URL) -> a Repository instance.
125
"""
126
control = bzrdir.BzrDir.open(base, _unsupported)
127
return control.open_branch(_unsupported)
119
128
120
129
@staticmethod
121
130
def open_containing(url):
125
134
126
135
Basically we keep looking up until we find the control directory or
127
136
run into the root. If there isn't one, raises NotBranchError.
137
If there is one and it is either an unrecognised format or an unsupported
138
format, UnknownFormatError or UnsupportedFormatError are raised.
128
139
If there is one, it is returned, along with the unused portion of url.
129
140
"""
130
t = get_transport(url)
131
while True:
132
try:
133
return _Branch(t), t.relpath(url)
134
except NotBranchError:
135
pass
136
new_t = t.clone('..')
137
if new_t.base == t.base:
138
# reached the root, whatever that may be
139
raise NotBranchError(path=url)
140
t = new_t
141
control, relpath = bzrdir.BzrDir.open_containing(url)
142
return control.open_branch(), relpath
141
143
142
144
@staticmethod
145
@deprecated_function(zero_eight)
143
146
def initialize(base):
144
"""Create a new branch, rooted at 'base' (url)"""
145
t = get_transport(base)
146
return _Branch(t, init=True)
147
"""Create a new working tree and branch, rooted at 'base' (url)
148
149
NOTE: This will soon be deprecated in favour of creation
150
through a BzrDir.
151
"""
152
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
147
153
148
154
def setup_caching(self, cache_root):
149
155
"""Subclasses that care about caching should override this, and set
150
156
up cached stores located under cache_root.
151
157
"""
158
# seems to be unused, 2006-01-13 mbp
159
warn('%s is deprecated' % self.setup_caching)
152
160
self.cache_root = cache_root
153
161
154
155
class _Branch(Branch):
156
"""A branch stored in the actual filesystem.
157
158
Note that it's "local" in the context of the filesystem; it doesn't
159
really matter if it's on an nfs/smb/afs/coda/... share, as long as
160
it's writable, and can be accessed via the normal filesystem API.
161
162
_lock_mode
163
None, or 'r' or 'w'
164
165
_lock_count
166
If _lock_mode is true, a positive count of the number of times the
167
lock has been taken.
168
169
_lock
170
Lock object from bzrlib.lock.
171
"""
172
# We actually expect this class to be somewhat short-lived; part of its
173
# purpose is to try to isolate what bits of the branch logic are tied to
174
# filesystem access, so that in a later step, we can extricate them to
175
# a separarte ("storage") class.
176
_lock_mode = None
177
_lock_count = None
178
_lock = None
179
_inventory_weave = None
180
181
# Map some sort of prefix into a namespace
182
# stuff like "revno:10", "revid:", etc.
183
# This should match a prefix with a function which accepts
184
REVISION_NAMESPACES = {}
185
186
def push_stores(self, branch_to):
187
"""Copy the content of this branches store to branch_to."""
188
if (self._branch_format != branch_to._branch_format
189
or self._branch_format != 4):
190
from bzrlib.fetch import greedy_fetch
191
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
192
self, self._branch_format, branch_to, branch_to._branch_format)
193
greedy_fetch(to_branch=branch_to, from_branch=self,
194
revision=self.last_revision())
195
return
196
197
store_pairs = ((self.text_store, branch_to.text_store),
198
(self.inventory_store, branch_to.inventory_store),
199
(self.revision_store, branch_to.revision_store))
200
try:
201
for from_store, to_store in store_pairs:
202
copy_all(from_store, to_store)
203
except UnlistableStore:
204
raise UnlistableBranch(from_store)
205
206
def __init__(self, transport, init=False,
207
relax_version_check=False):
208
"""Create new branch object at a particular location.
209
210
transport -- A Transport object, defining how to access files.
211
(If a string, transport.transport() will be used to
212
create a Transport object)
213
214
init -- If True, create new control files in a previously
215
unversioned directory. If False, the branch must already
216
be versioned.
217
218
relax_version_check -- If true, the usual check for the branch
219
version is not applied. This is intended only for
220
upgrade/recovery type use; it's not guaranteed that
221
all operations will work on old format branches.
222
223
In the test suite, creation of new trees is tested using the
224
`ScratchBranch` class.
225
"""
226
assert isinstance(transport, Transport), \
227
"%r is not a Transport" % transport
228
self._transport = transport
229
if init:
230
self._make_control()
231
self._check_format(relax_version_check)
232
233
def get_store(name, compressed=True, prefixed=False):
234
# FIXME: This approach of assuming stores are all entirely compressed
235
# or entirely uncompressed is tidy, but breaks upgrade from
236
# some existing branches where there's a mixture; we probably
237
# still want the option to look for both.
238
relpath = self._rel_controlfilename(name)
239
if compressed:
240
store = CompressedTextStore(self._transport.clone(relpath),
241
prefixed=prefixed)
242
else:
243
store = TextStore(self._transport.clone(relpath),
244
prefixed=prefixed)
245
#if self._transport.should_cache():
246
# cache_path = os.path.join(self.cache_root, name)
247
# os.mkdir(cache_path)
248
# store = bzrlib.store.CachedStore(store, cache_path)
249
return store
250
def get_weave(name, prefixed=False):
251
relpath = self._rel_controlfilename(name)
252
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
253
if self._transport.should_cache():
254
ws.enable_cache = True
255
return ws
256
257
if self._branch_format == 4:
258
self.inventory_store = get_store('inventory-store')
259
self.text_store = get_store('text-store')
260
self.revision_store = get_store('revision-store')
261
elif self._branch_format == 5:
262
self.control_weaves = get_weave('')
263
self.weave_store = get_weave('weaves')
264
self.revision_store = get_store('revision-store', compressed=False)
265
elif self._branch_format == 6:
266
self.control_weaves = get_weave('')
267
self.weave_store = get_weave('weaves', prefixed=True)
268
self.revision_store = get_store('revision-store', compressed=False,
269
prefixed=True)
270
self.revision_store.register_suffix('sig')
271
self._transaction = None
272
273
def __str__(self):
274
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
275
276
277
__repr__ = __str__
278
279
280
def __del__(self):
281
if self._lock_mode or self._lock:
282
# XXX: This should show something every time, and be suitable for
283
# headless operation and embedding
284
warn("branch %r was not explicitly unlocked" % self)
285
self._lock.unlock()
286
287
# TODO: It might be best to do this somewhere else,
288
# but it is nice for a Branch object to automatically
289
# cache it's information.
290
# Alternatively, we could have the Transport objects cache requests
291
# See the earlier discussion about how major objects (like Branch)
292
# should never expect their __del__ function to run.
293
if hasattr(self, 'cache_root') and self.cache_root is not None:
294
try:
295
import shutil
296
shutil.rmtree(self.cache_root)
297
except:
298
pass
299
self.cache_root = None
300
301
def _get_base(self):
302
if self._transport:
303
return self._transport.base
304
return None
305
306
base = property(_get_base, doc="The URL for the root of this branch.")
307
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
312
self)
313
transaction = self._transaction
314
self._transaction = None
315
transaction.finish()
316
317
def get_transaction(self):
318
"""Return the current active transaction.
319
320
If no transaction is active, this returns a passthrough object
321
for which all data is immedaitely flushed and no caching happens.
322
"""
323
if self._transaction is None:
324
return transactions.PassThroughTransaction()
325
else:
326
return self._transaction
327
328
def _set_transaction(self, new_transaction):
329
"""Set a new active transaction."""
330
if self._transaction is not None:
331
raise errors.LockError('Branch %s is in a transaction already.' %
332
self)
333
self._transaction = new_transaction
162
def _get_nick(self):
163
cfg = self.tree_config()
164
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
165
166
def _set_nick(self, nick):
167
cfg = self.tree_config()
168
cfg.set_option(nick, "nickname")
169
assert cfg.get_option("nickname") == nick
170
171
nick = property(_get_nick, _set_nick)
172
173
def is_locked(self):
174
raise NotImplementedError('is_locked is abstract')
334
175
335
176
def lock_write(self):
336
mutter("lock write: %s (%s)", self, self._lock_count)
337
# TODO: Upgrade locking to support using a Transport,
338
# and potentially a remote locking protocol
339
if self._lock_mode:
340
if self._lock_mode != 'w':
341
raise LockError("can't upgrade to a write lock from %r" %
342
self._lock_mode)
343
self._lock_count += 1
344
else:
345
self._lock = self._transport.lock_write(
346
self._rel_controlfilename('branch-lock'))
347
self._lock_mode = 'w'
348
self._lock_count = 1
349
self._set_transaction(transactions.PassThroughTransaction())
177
raise NotImplementedError('lock_write is abstract')
350
178
351
179
def lock_read(self):
352
mutter("lock read: %s (%s)", self, self._lock_count)
353
if self._lock_mode:
354
assert self._lock_mode in ('r', 'w'), \
355
"invalid lock mode %r" % self._lock_mode
356
self._lock_count += 1
357
else:
358
self._lock = self._transport.lock_read(
359
self._rel_controlfilename('branch-lock'))
360
self._lock_mode = 'r'
361
self._lock_count = 1
362
self._set_transaction(transactions.ReadOnlyTransaction())
363
# 5K may be excessive, but hey, its a knob.
364
self.get_transaction().set_cache_size(5000)
365
180
raise NotImplementedError('lock_read is abstract')
181
366
182
def unlock(self):
367
mutter("unlock: %s (%s)", self, self._lock_count)
368
if not self._lock_mode:
369
raise LockError('branch %r is not locked' % (self))
370
371
if self._lock_count > 1:
372
self._lock_count -= 1
373
else:
374
self._finish_transaction()
375
self._lock.unlock()
376
self._lock = None
377
self._lock_mode = self._lock_count = None
183
raise NotImplementedError('unlock is abstract')
184
185
def peek_lock_mode(self):
186
"""Return lock mode for the Branch: 'r', 'w' or None"""
187
raise NotImplementedError(self.peek_lock_mode)
188
189
def get_physical_lock_status(self):
190
raise NotImplementedError('get_physical_lock_status is abstract')
378
191
379
192
def abspath(self, name):
380
193
"""Return absolute filename for something in the branch
382
195
XXX: Robert Collins 20051017 what is this used for? why is it a branch
383
196
method and not a tree method.
384
197
"""
385
return self._transport.abspath(name)
386
387
def _rel_controlfilename(self, file_or_path):
388
if not isinstance(file_or_path, basestring):
389
file_or_path = '/'.join(file_or_path)
390
if file_or_path == '':
391
return bzrlib.BZRDIR
392
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
393
394
def controlfilename(self, file_or_path):
395
"""Return location relative to branch."""
396
return self._transport.abspath(self._rel_controlfilename(file_or_path))
397
398
399
def controlfile(self, file_or_path, mode='r'):
400
"""Open a control file for this branch.
401
402
There are two classes of file in the control directory: text
403
and binary. binary files are untranslated byte streams. Text
404
control files are stored with Unix newlines and in UTF-8, even
405
if the platform or locale defaults are different.
406
407
Controlfiles should almost never be opened in write mode but
408
rather should be atomically copied and replaced using atomicfile.
409
"""
410
import codecs
411
412
relpath = self._rel_controlfilename(file_or_path)
413
#TODO: codecs.open() buffers linewise, so it was overloaded with
414
# a much larger buffer, do we need to do the same for getreader/getwriter?
415
if mode == 'rb':
416
return self._transport.get(relpath)
417
elif mode == 'wb':
418
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
419
elif mode == 'r':
420
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
421
elif mode == 'w':
422
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
198
raise NotImplementedError('abspath is abstract')
199
200
def bind(self, other):
201
"""Bind the local branch the other branch.
202
203
:param other: The branch to bind to
204
:type other: Branch
205
"""
206
raise errors.UpgradeRequired(self.base)
207
208
@needs_write_lock
209
def fetch(self, from_branch, last_revision=None, pb=None):
210
"""Copy revisions from from_branch into this branch.
211
212
:param from_branch: Where to copy from.
213
:param last_revision: What revision to stop at (None for at the end
214
of the branch.
215
:param pb: An optional progress bar to use.
216
217
Returns the copied revision count and the failed revisions in a tuple:
218
(copied, failures).
219
"""
220
if self.base == from_branch.base:
221
return (0, [])
222
if pb is None:
223
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
224
pb = nested_pb
423
225
else:
424
raise BzrError("invalid controlfile mode %r" % mode)
425
426
def put_controlfile(self, path, f, encode=True):
427
"""Write an entry as a controlfile.
428
429
:param path: The path to put the file, relative to the .bzr control
430
directory
431
:param f: A file-like or string object whose contents should be copied.
432
:param encode: If true, encode the contents as utf-8
433
"""
434
self.put_controlfiles([(path, f)], encode=encode)
435
436
def put_controlfiles(self, files, encode=True):
437
"""Write several entries as controlfiles.
438
439
:param files: A list of [(path, file)] pairs, where the path is the directory
440
underneath the bzr control directory
441
:param encode: If true, encode the contents as utf-8
442
"""
443
import codecs
444
ctrl_files = []
445
for path, f in files:
446
if encode:
447
if isinstance(f, basestring):
448
f = f.encode('utf-8', 'replace')
226
nested_pb = None
227
228
from_branch.lock_read()
229
try:
230
if last_revision is None:
231
pb.update('get source history')
232
from_history = from_branch.revision_history()
233
if from_history:
234
last_revision = from_history[-1]
449
235
else:
450
f = codecs.getwriter('utf-8')(f, errors='replace')
451
path = self._rel_controlfilename(path)
452
ctrl_files.append((path, f))
453
self._transport.put_multi(ctrl_files)
454
455
def _make_control(self):
456
from bzrlib.inventory import Inventory
457
from bzrlib.weavefile import write_weave_v5
458
from bzrlib.weave import Weave
236
# no history in the source branch
237
last_revision = NULL_REVISION
238
return self.repository.fetch(from_branch.repository,
239
revision_id=last_revision,
240
pb=nested_pb)
241
finally:
242
if nested_pb is not None:
243
nested_pb.finished()
244
from_branch.unlock()
245
246
def get_bound_location(self):
247
"""Return the URL of the branch we are bound to.
248
249
Older format branches cannot bind, please be sure to use a metadir
250
branch.
251
"""
252
return None
253
254
def get_master_branch(self):
255
"""Return the branch we are bound to.
459
256
460
# Create an empty inventory
461
sio = StringIO()
462
# if we want per-tree root ids then this is the place to set
463
# them; they're not needed for now and so ommitted for
464
# simplicity.
465
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
466
empty_inv = sio.getvalue()
467
sio = StringIO()
468
bzrlib.weavefile.write_weave_v5(Weave(), sio)
469
empty_weave = sio.getvalue()
470
471
dirs = [[], 'revision-store', 'weaves']
472
files = [('README',
473
"This is a Bazaar-NG control directory.\n"
474
"Do not change any files in this directory.\n"),
475
('branch-format', BZR_BRANCH_FORMAT_6),
476
('revision-history', ''),
477
('branch-name', ''),
478
('branch-lock', ''),
479
('pending-merges', ''),
480
('inventory', empty_inv),
481
('inventory.weave', empty_weave),
482
('ancestry.weave', empty_weave)
483
]
484
cfn = self._rel_controlfilename
485
self._transport.mkdir_multi([cfn(d) for d in dirs])
486
self.put_controlfiles(files)
487
mutter('created control directory in ' + self._transport.base)
488
489
def _check_format(self, relax_version_check):
490
"""Check this branch format is supported.
491
492
The format level is stored, as an integer, in
493
self._branch_format for code that needs to check it later.
494
495
In the future, we might need different in-memory Branch
496
classes to support downlevel branches. But not yet.
257
:return: Either a Branch, or None
497
258
"""
498
try:
499
fmt = self.controlfile('branch-format', 'r').read()
500
except NoSuchFile:
501
raise NotBranchError(path=self.base)
502
mutter("got branch format %r", fmt)
503
if fmt == BZR_BRANCH_FORMAT_6:
504
self._branch_format = 6
505
elif fmt == BZR_BRANCH_FORMAT_5:
506
self._branch_format = 5
507
elif fmt == BZR_BRANCH_FORMAT_4:
508
self._branch_format = 4
509
510
if (not relax_version_check
511
and self._branch_format not in (5, 6)):
512
raise errors.UnsupportedFormatError(
513
'sorry, branch format %r not supported' % fmt,
514
['use a different bzr version',
515
'or remove the .bzr directory'
516
' and "bzr init" again'])
259
return None
517
260
518
261
def get_root_id(self):
519
262
"""Return the id of this branches root"""
520
inv = self.read_working_inventory()
521
return inv.root.file_id
522
523
def set_root_id(self, file_id):
524
inv = self.read_working_inventory()
525
orig_root_id = inv.root.file_id
526
del inv._byid[inv.root.file_id]
527
inv.root.file_id = file_id
528
inv._byid[inv.root.file_id] = inv.root
529
for fid in inv:
530
entry = inv[fid]
531
if entry.parent_id in (None, orig_root_id):
532
entry.parent_id = inv.root.file_id
533
self._write_inventory(inv)
534
535
@needs_read_lock
536
def read_working_inventory(self):
537
"""Read the working inventory."""
538
# ElementTree does its own conversion from UTF-8, so open in
539
# binary.
540
f = self.controlfile('inventory', 'rb')
541
return bzrlib.xml5.serializer_v5.read_inventory(f)
542
543
@needs_write_lock
544
def _write_inventory(self, inv):
545
"""Update the working inventory.
546
547
That is to say, the inventory describing changes underway, that
548
will be committed to the next revision.
549
"""
550
from cStringIO import StringIO
551
sio = StringIO()
552
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
553
sio.seek(0)
554
# Transport handles atomicity
555
self.put_controlfile('inventory', sio)
556
557
mutter('wrote working inventory')
558
559
inventory = property(read_working_inventory, _write_inventory, None,
560
"""Inventory for the working copy.""")
561
562
@needs_write_lock
563
def add(self, files, ids=None):
564
"""Make files versioned.
565
566
Note that the command line normally calls smart_add instead,
567
which can automatically recurse.
568
569
This puts the files in the Added state, so that they will be
570
recorded by the next commit.
571
572
files
573
List of paths to add, relative to the base of the tree.
574
575
ids
576
If set, use these instead of automatically generated ids.
577
Must be the same length as the list of files, but may
578
contain None for ids that are to be autogenerated.
579
580
TODO: Perhaps have an option to add the ids even if the files do
581
not (yet) exist.
582
583
TODO: Perhaps yield the ids and paths as they're added.
584
"""
585
# TODO: Re-adding a file that is removed in the working copy
586
# should probably put it back with the previous ID.
587
if isinstance(files, basestring):
588
assert(ids is None or isinstance(ids, basestring))
589
files = [files]
590
if ids is not None:
591
ids = [ids]
592
593
if ids is None:
594
ids = [None] * len(files)
595
else:
596
assert(len(ids) == len(files))
597
598
inv = self.read_working_inventory()
599
for f,file_id in zip(files, ids):
600
if is_control_file(f):
601
raise BzrError("cannot add control file %s" % quotefn(f))
602
603
fp = splitpath(f)
604
605
if len(fp) == 0:
606
raise BzrError("cannot add top-level %r" % f)
607
608
fullpath = os.path.normpath(self.abspath(f))
609
610
try:
611
kind = file_kind(fullpath)
612
except OSError:
613
# maybe something better?
614
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
615
616
if not InventoryEntry.versionable_kind(kind):
617
raise BzrError('cannot add: not a versionable file ('
618
'i.e. regular file, symlink or directory): %s' % quotefn(f))
619
620
if file_id is None:
621
file_id = gen_file_id(f)
622
inv.add_path(f, kind=kind, file_id=file_id)
623
624
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
625
626
self._write_inventory(inv)
627
628
@needs_read_lock
629
def print_file(self, file, revno):
263
raise NotImplementedError('get_root_id is abstract')
264
265
def print_file(self, file, revision_id):
630
266
"""Print `file` to stdout."""
631
tree = self.revision_tree(self.get_rev_id(revno))
632
# use inventory as it was in that revision
633
file_id = tree.inventory.path2id(file)
634
if not file_id:
635
raise BzrError("%r is not present in revision %s" % (file, revno))
636
tree.print_file(file_id)
637
638
# FIXME: this doesn't need to be a branch method
639
def set_inventory(self, new_inventory_list):
640
from bzrlib.inventory import Inventory, InventoryEntry
641
inv = Inventory(self.get_root_id())
642
for path, file_id, parent, kind in new_inventory_list:
643
name = os.path.basename(path)
644
if name == "":
645
continue
646
# fixme, there should be a factory function inv,add_??
647
if kind == 'directory':
648
inv.add(inventory.InventoryDirectory(file_id, name, parent))
649
elif kind == 'file':
650
inv.add(inventory.InventoryFile(file_id, name, parent))
651
elif kind == 'symlink':
652
inv.add(inventory.InventoryLink(file_id, name, parent))
653
else:
654
raise BzrError("unknown kind %r" % kind)
655
self._write_inventory(inv)
656
657
def unknowns(self):
658
"""Return all unknown files.
659
660
These are files in the working directory that are not versioned or
661
control files or ignored.
662
663
>>> from bzrlib.workingtree import WorkingTree
664
>>> b = ScratchBranch(files=['foo', 'foo~'])
665
>>> map(str, b.unknowns())
666
['foo']
667
>>> b.add('foo')
668
>>> list(b.unknowns())
669
[]
670
>>> WorkingTree(b.base, b).remove('foo')
671
>>> list(b.unknowns())
672
[u'foo']
673
"""
674
return self.working_tree().unknowns()
675
676
@needs_write_lock
267
raise NotImplementedError('print_file is abstract')
268
677
269
def append_revision(self, *revision_ids):
678
for revision_id in revision_ids:
679
mutter("add {%s} to revision-history" % revision_id)
680
rev_history = self.revision_history()
681
rev_history.extend(revision_ids)
682
self.set_revision_history(rev_history)
270
raise NotImplementedError('append_revision is abstract')
683
271
684
@needs_write_lock
685
272
def set_revision_history(self, rev_history):
686
self.put_controlfile('revision-history', '\n'.join(rev_history))
687
688
def has_revision(self, revision_id):
689
"""True if this branch has a copy of the revision.
690
691
This does not necessarily imply the revision is merge
692
or on the mainline."""
693
return (revision_id is None
694
or self.revision_store.has_id(revision_id))
695
696
@needs_read_lock
697
def get_revision_xml_file(self, revision_id):
698
"""Return XML file object for revision object."""
699
if not revision_id or not isinstance(revision_id, basestring):
700
raise InvalidRevisionId(revision_id)
701
try:
702
return self.revision_store.get(revision_id)
703
except (IndexError, KeyError):
704
raise bzrlib.errors.NoSuchRevision(self, revision_id)
705
706
#deprecated
707
get_revision_xml = get_revision_xml_file
708
709
def get_revision_xml(self, revision_id):
710
return self.get_revision_xml_file(revision_id).read()
711
712
713
def get_revision(self, revision_id):
714
"""Return the Revision object for a named revision"""
715
xml_file = self.get_revision_xml_file(revision_id)
716
717
try:
718
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
719
except SyntaxError, e:
720
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
721
[revision_id,
722
str(e)])
723
724
assert r.revision_id == revision_id
725
return r
726
727
def get_revision_delta(self, revno):
728
"""Return the delta for one revision.
729
730
The delta is relative to its mainline predecessor, or the
731
empty tree for revision 1.
732
"""
733
assert isinstance(revno, int)
734
rh = self.revision_history()
735
if not (1 <= revno <= len(rh)):
736
raise InvalidRevisionNumber(revno)
737
738
# revno is 1-based; list is 0-based
739
740
new_tree = self.revision_tree(rh[revno-1])
741
if revno == 1:
742
old_tree = EmptyTree()
743
else:
744
old_tree = self.revision_tree(rh[revno-2])
745
746
return compare_trees(old_tree, new_tree)
747
748
def get_revision_sha1(self, revision_id):
749
"""Hash the stored value of a revision, and return it."""
750
# In the future, revision entries will be signed. At that
751
# point, it is probably best *not* to include the signature
752
# in the revision hash. Because that lets you re-sign
753
# the revision, (add signatures/remove signatures) and still
754
# have all hash pointers stay consistent.
755
# But for now, just hash the contents.
756
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
757
758
def get_ancestry(self, revision_id):
759
"""Return a list of revision-ids integrated by a revision.
760
761
This currently returns a list, but the ordering is not guaranteed:
762
treat it as a set.
763
"""
764
if revision_id is None:
765
return [None]
766
w = self.get_inventory_weave()
767
return [None] + map(w.idx_to_name,
768
w.inclusions([w.lookup(revision_id)]))
769
770
def get_inventory_weave(self):
771
return self.control_weaves.get_weave('inventory',
772
self.get_transaction())
773
774
def get_inventory(self, revision_id):
775
"""Get Inventory object by hash."""
776
xml = self.get_inventory_xml(revision_id)
777
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
778
779
def get_inventory_xml(self, revision_id):
780
"""Get inventory XML as a file object."""
781
try:
782
assert isinstance(revision_id, basestring), type(revision_id)
783
iw = self.get_inventory_weave()
784
return iw.get_text(iw.lookup(revision_id))
785
except IndexError:
786
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
787
788
def get_inventory_sha1(self, revision_id):
789
"""Return the sha1 hash of the inventory entry
790
"""
791
return self.get_revision(revision_id).inventory_sha1
792
793
def get_revision_inventory(self, revision_id):
794
"""Return inventory of a past revision."""
795
# TODO: Unify this with get_inventory()
796
# bzr 0.0.6 and later imposes the constraint that the inventory_id
797
# must be the same as its revision, so this is trivial.
798
if revision_id == None:
799
return Inventory(self.get_root_id())
800
else:
801
return self.get_inventory(revision_id)
802
803
@needs_read_lock
273
raise NotImplementedError('set_revision_history is abstract')
274
804
275
def revision_history(self):
805
276
"""Return sequence of revision hashes on to this branch."""
806
transaction = self.get_transaction()
807
history = transaction.map.find_revision_history()
808
if history is not None:
809
mutter("cache hit for revision-history in %s", self)
810
return list(history)
811
history = [l.rstrip('\r\n') for l in
812
self.controlfile('revision-history', 'r').readlines()]
813
transaction.map.add_revision_history(history)
814
# this call is disabled because revision_history is
815
# not really an object yet, and the transaction is for objects.
816
# transaction.register_clean(history, precious=True)
817
return list(history)
277
raise NotImplementedError('revision_history is abstract')
818
278
819
279
def revno(self):
820
280
"""Return current revision number for this branch.
824
284
"""
825
285
return len(self.revision_history())
826
286
287
def unbind(self):
288
"""Older format branches cannot bind or unbind."""
289
raise errors.UpgradeRequired(self.base)
290
827
291
def last_revision(self):
828
"""Return last patch hash, or None if no history.
829
"""
292
"""Return last patch hash, or None if no history."""
830
293
ph = self.revision_history()
831
294
if ph:
832
295
return ph[-1]
833
296
else:
834
297
return None
835
298
836
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
299
def missing_revisions(self, other, stop_revision=None):
837
300
"""Return a list of new revisions that would perfectly fit.
838
301
839
302
If self and other have not diverged, return a list of the revisions
840
303
present in other, but missing from self.
841
304
842
>>> from bzrlib.commit import commit
305
>>> from bzrlib.workingtree import WorkingTree
843
306
>>> bzrlib.trace.silent = True
844
>>> br1 = ScratchBranch()
845
>>> br2 = ScratchBranch()
307
>>> d1 = bzrdir.ScratchDir()
308
>>> br1 = d1.open_branch()
309
>>> wt1 = d1.open_workingtree()
310
>>> d2 = bzrdir.ScratchDir()
311
>>> br2 = d2.open_branch()
312
>>> wt2 = d2.open_workingtree()
846
313
>>> br1.missing_revisions(br2)
847
314
[]
848
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
315
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
849
316
>>> br1.missing_revisions(br2)
850
317
[u'REVISION-ID-1']
851
318
>>> br2.missing_revisions(br1)
852
319
[]
853
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
320
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
854
321
>>> br1.missing_revisions(br2)
855
322
[]
856
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
323
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
857
324
>>> br1.missing_revisions(br2)
858
325
[u'REVISION-ID-2A']
859
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
326
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
860
327
>>> br1.missing_revisions(br2)
861
328
Traceback (most recent call last):
862
DivergedBranches: These branches have diverged.
329
DivergedBranches: These branches have diverged. Try merge.
863
330
"""
864
331
self_history = self.revision_history()
865
332
self_len = len(self_history)
879
346
return other_history[self_len:stop_revision]
880
347
881
348
def update_revisions(self, other, stop_revision=None):
882
"""Pull in new perfect-fit revisions."""
883
# FIXME: If the branches have diverged, but the latest
884
# revision in this branch is completely merged into the other,
885
# then we should still be able to pull.
886
from bzrlib.fetch import greedy_fetch
887
if stop_revision is None:
888
stop_revision = other.last_revision()
889
### Should this be checking is_ancestor instead of revision_history?
890
if (stop_revision is not None and
891
stop_revision in self.revision_history()):
892
return
893
greedy_fetch(to_branch=self, from_branch=other,
894
revision=stop_revision)
895
pullable_revs = self.pullable_revisions(other, stop_revision)
896
if len(pullable_revs) > 0:
897
self.append_revision(*pullable_revs)
898
899
def pullable_revisions(self, other, stop_revision):
900
other_revno = other.revision_id_to_revno(stop_revision)
901
try:
902
return self.missing_revisions(other, other_revno)
903
except DivergedBranches, e:
904
try:
905
pullable_revs = get_intervening_revisions(self.last_revision(),
906
stop_revision, self)
907
assert self.last_revision() not in pullable_revs
908
return pullable_revs
909
except bzrlib.errors.NotAncestor:
910
if is_ancestor(self.last_revision(), stop_revision, self):
911
return []
912
else:
913
raise e
914
915
def commit(self, *args, **kw):
916
from bzrlib.commit import Commit
917
Commit().commit(self, *args, **kw)
918
349
"""Pull in new perfect-fit revisions.
350
351
:param other: Another Branch to pull from
352
:param stop_revision: Updated until the given revision
353
:return: None
354
"""
355
raise NotImplementedError('update_revisions is abstract')
356
919
357
def revision_id_to_revno(self, revision_id):
920
358
"""Given a revision id, return its revno"""
921
359
if revision_id is None:
936
374
raise bzrlib.errors.NoSuchRevision(self, revno)
937
375
return history[revno - 1]
938
376
939
def revision_tree(self, revision_id):
940
"""Return Tree for a revision on this branch.
941
942
`revision_id` may be None for the null revision, in which case
943
an `EmptyTree` is returned."""
944
# TODO: refactor this to use an existing revision object
945
# so we don't need to read it in twice.
946
if revision_id == None:
947
return EmptyTree()
948
else:
949
inv = self.get_revision_inventory(revision_id)
950
return RevisionTree(self.weave_store, inv, revision_id)
951
952
def working_tree(self):
953
"""Return a `Tree` for the working copy."""
954
from bzrlib.workingtree import WorkingTree
955
# TODO: In the future, perhaps WorkingTree should utilize Transport
956
# RobertCollins 20051003 - I don't think it should - working trees are
957
# much more complex to keep consistent than our careful .bzr subset.
958
# instead, we should say that working trees are local only, and optimise
959
# for that.
960
return WorkingTree(self.base, branch=self)
961
377
def pull(self, source, overwrite=False, stop_revision=None):
378
raise NotImplementedError('pull is abstract')
962
379
963
380
def basis_tree(self):
964
381
"""Return `Tree` object for last revision.
965
382
966
383
If there are no revisions yet, return an `EmptyTree`.
967
384
"""
968
return self.revision_tree(self.last_revision())
385
return self.repository.revision_tree(self.last_revision())
969
386
970
@needs_write_lock
971
387
def rename_one(self, from_rel, to_rel):
972
388
"""Rename one file.
973
389
974
390
This can change the directory or the filename or both.
975
391
"""
976
tree = self.working_tree()
977
inv = tree.inventory
978
if not tree.has_filename(from_rel):
979
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
980
if tree.has_filename(to_rel):
981
raise BzrError("can't rename: new working file %r already exists" % to_rel)
982
983
file_id = inv.path2id(from_rel)
984
if file_id == None:
985
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
986
987
if inv.path2id(to_rel):
988
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
989
990
to_dir, to_tail = os.path.split(to_rel)
991
to_dir_id = inv.path2id(to_dir)
992
if to_dir_id == None and to_dir != '':
993
raise BzrError("can't determine destination directory id for %r" % to_dir)
994
995
mutter("rename_one:")
996
mutter(" file_id {%s}" % file_id)
997
mutter(" from_rel %r" % from_rel)
998
mutter(" to_rel %r" % to_rel)
999
mutter(" to_dir %r" % to_dir)
1000
mutter(" to_dir_id {%s}" % to_dir_id)
1001
1002
inv.rename(file_id, to_dir_id, to_tail)
1003
1004
from_abs = self.abspath(from_rel)
1005
to_abs = self.abspath(to_rel)
1006
try:
1007
rename(from_abs, to_abs)
1008
except OSError, e:
1009
raise BzrError("failed to rename %r to %r: %s"
1010
% (from_abs, to_abs, e[1]),
1011
["rename rolled back"])
1012
1013
self._write_inventory(inv)
1014
1015
@needs_write_lock
392
raise NotImplementedError('rename_one is abstract')
393
1016
394
def move(self, from_paths, to_name):
1017
395
"""Rename files.
1018
396
1027
405
This returns a list of (from_path, to_path) pairs for each
1028
406
entry that is moved.
1029
407
"""
1030
result = []
1031
## TODO: Option to move IDs only
1032
assert not isinstance(from_paths, basestring)
1033
tree = self.working_tree()
1034
inv = tree.inventory
1035
to_abs = self.abspath(to_name)
1036
if not isdir(to_abs):
1037
raise BzrError("destination %r is not a directory" % to_abs)
1038
if not tree.has_filename(to_name):
1039
raise BzrError("destination %r not in working directory" % to_abs)
1040
to_dir_id = inv.path2id(to_name)
1041
if to_dir_id == None and to_name != '':
1042
raise BzrError("destination %r is not a versioned directory" % to_name)
1043
to_dir_ie = inv[to_dir_id]
1044
if to_dir_ie.kind not in ('directory', 'root_directory'):
1045
raise BzrError("destination %r is not a directory" % to_abs)
1046
1047
to_idpath = inv.get_idpath(to_dir_id)
1048
1049
for f in from_paths:
1050
if not tree.has_filename(f):
1051
raise BzrError("%r does not exist in working tree" % f)
1052
f_id = inv.path2id(f)
1053
if f_id == None:
1054
raise BzrError("%r is not versioned" % f)
1055
name_tail = splitpath(f)[-1]
1056
dest_path = appendpath(to_name, name_tail)
1057
if tree.has_filename(dest_path):
1058
raise BzrError("destination %r already exists" % dest_path)
1059
if f_id in to_idpath:
1060
raise BzrError("can't move %r to a subdirectory of itself" % f)
1061
1062
# OK, so there's a race here, it's possible that someone will
1063
# create a file in this interval and then the rename might be
1064
# left half-done. But we should have caught most problems.
1065
1066
for f in from_paths:
1067
name_tail = splitpath(f)[-1]
1068
dest_path = appendpath(to_name, name_tail)
1069
result.append((f, dest_path))
1070
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1071
try:
1072
rename(self.abspath(f), self.abspath(dest_path))
1073
except OSError, e:
1074
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1075
["rename rolled back"])
1076
1077
self._write_inventory(inv)
1078
return result
1079
1080
1081
def revert(self, filenames, old_tree=None, backups=True):
1082
"""Restore selected files to the versions from a previous tree.
1083
1084
backups
1085
If true (default) backups are made of files before
1086
they're renamed.
1087
"""
1088
from bzrlib.atomicfile import AtomicFile
1089
from bzrlib.osutils import backup_file
1090
1091
inv = self.read_working_inventory()
1092
if old_tree is None:
1093
old_tree = self.basis_tree()
1094
old_inv = old_tree.inventory
1095
1096
nids = []
1097
for fn in filenames:
1098
file_id = inv.path2id(fn)
1099
if not file_id:
1100
raise NotVersionedError(path=fn)
1101
if not old_inv.has_id(file_id):
1102
raise BzrError("file not present in old tree", fn, file_id)
1103
nids.append((fn, file_id))
1104
1105
# TODO: Rename back if it was previously at a different location
1106
1107
# TODO: If given a directory, restore the entire contents from
1108
# the previous version.
1109
1110
# TODO: Make a backup to a temporary file.
1111
1112
# TODO: If the file previously didn't exist, delete it?
1113
for fn, file_id in nids:
1114
backup_file(fn)
1115
1116
f = AtomicFile(fn, 'wb')
1117
try:
1118
f.write(old_tree.get_file(file_id).read())
1119
f.commit()
1120
finally:
1121
f.close()
1122
1123
1124
def pending_merges(self):
1125
"""Return a list of pending merges.
1126
1127
These are revisions that have been merged into the working
1128
directory but not yet committed.
1129
"""
1130
cfn = self._rel_controlfilename('pending-merges')
1131
if not self._transport.has(cfn):
1132
return []
1133
p = []
1134
for l in self.controlfile('pending-merges', 'r').readlines():
1135
p.append(l.rstrip('\n'))
1136
return p
1137
1138
1139
def add_pending_merge(self, *revision_ids):
1140
# TODO: Perhaps should check at this point that the
1141
# history of the revision is actually present?
1142
p = self.pending_merges()
1143
updated = False
1144
for rev_id in revision_ids:
1145
if rev_id in p:
1146
continue
1147
p.append(rev_id)
1148
updated = True
1149
if updated:
1150
self.set_pending_merges(p)
1151
1152
@needs_write_lock
1153
def set_pending_merges(self, rev_list):
1154
self.put_controlfile('pending-merges', '\n'.join(rev_list))
408
raise NotImplementedError('move is abstract')
1155
409
1156
410
def get_parent(self):
1157
411
"""Return the parent location of the branch.
1160
414
pattern is that the user can override it by specifying a
1161
415
location.
1162
416
"""
1163
import errno
1164
_locs = ['parent', 'pull', 'x-pull']
1165
for l in _locs:
1166
try:
1167
return self.controlfile(l, 'r').read().strip('\n')
1168
except IOError, e:
1169
if e.errno != errno.ENOENT:
1170
raise
417
raise NotImplementedError('get_parent is abstract')
418
419
def get_push_location(self):
420
"""Return the None or the location to push this branch to."""
421
raise NotImplementedError('get_push_location is abstract')
422
423
def set_push_location(self, location):
424
"""Set a new push location for this branch."""
425
raise NotImplementedError('set_push_location is abstract')
426
427
def set_parent(self, url):
428
raise NotImplementedError('set_parent is abstract')
429
430
@needs_write_lock
431
def update(self):
432
"""Synchronise this branch with the master branch if any.
433
434
:return: None or the last_revision pivoted out during the update.
435
"""
1171
436
return None
1172
437
1173
@needs_write_lock
1174
def set_parent(self, url):
1175
# TODO: Maybe delete old location files?
1176
from bzrlib.atomicfile import AtomicFile
1177
f = AtomicFile(self.controlfilename('parent'))
1178
try:
1179
f.write(url + '\n')
1180
f.commit()
1181
finally:
1182
f.close()
1183
1184
438
def check_revno(self, revno):
1185
439
"""\
1186
440
Check whether a revno corresponds to any revision.
1196
450
"""
1197
451
if revno < 1 or revno > self.revno():
1198
452
raise InvalidRevisionNumber(revno)
1199
1200
def sign_revision(self, revision_id, gpg_strategy):
1201
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1202
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1203
1204
@needs_write_lock
1205
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1206
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1207
revision_id, "sig")
1208
1209
1210
class ScratchBranch(_Branch):
1211
"""Special test class: a branch that cleans up after itself.
1212
1213
>>> b = ScratchBranch()
1214
>>> isdir(b.base)
1215
True
1216
>>> bd = b.base
1217
>>> b._transport.__del__()
1218
>>> isdir(bd)
1219
False
1220
"""
1221
1222
def __init__(self, files=[], dirs=[], transport=None):
1223
"""Make a test branch.
1224
1225
This creates a temporary directory and runs init-tree in it.
1226
1227
If any files are listed, they are created in the working copy.
1228
"""
1229
if transport is None:
1230
transport = bzrlib.transport.local.ScratchTransport()
1231
super(ScratchBranch, self).__init__(transport, init=True)
1232
else:
1233
super(ScratchBranch, self).__init__(transport)
1234
1235
for d in dirs:
1236
self._transport.mkdir(d)
1237
1238
for f in files:
1239
self._transport.put(f, 'content of %s' % f)
1240
1241
1242
def clone(self):
1243
"""
1244
>>> orig = ScratchBranch(files=["file1", "file2"])
1245
>>> clone = orig.clone()
1246
>>> if os.name != 'nt':
1247
... os.path.samefile(orig.base, clone.base)
1248
... else:
1249
... orig.base == clone.base
1250
...
1251
False
1252
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1253
True
1254
"""
1255
from shutil import copytree
1256
from tempfile import mkdtemp
1257
base = mkdtemp()
1258
os.rmdir(base)
1259
copytree(self.base, base, symlinks=True)
1260
return ScratchBranch(
1261
transport=bzrlib.transport.local.ScratchTransport(base))
1262
453
454
@needs_read_lock
455
def clone(self, *args, **kwargs):
456
"""Clone this branch into to_bzrdir preserving all semantic values.
457
458
revision_id: if not None, the revision history in the new branch will
459
be truncated to end with revision_id.
460
"""
461
# for API compatability, until 0.8 releases we provide the old api:
462
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
463
# after 0.8 releases, the *args and **kwargs should be changed:
464
# def clone(self, to_bzrdir, revision_id=None):
465
if (kwargs.get('to_location', None) or
466
kwargs.get('revision', None) or
467
kwargs.get('basis_branch', None) or
468
(len(args) and isinstance(args[0], basestring))):
469
# backwards compatability api:
470
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
471
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
472
# get basis_branch
473
if len(args) > 2:
474
basis_branch = args[2]
475
else:
476
basis_branch = kwargs.get('basis_branch', None)
477
if basis_branch:
478
basis = basis_branch.bzrdir
479
else:
480
basis = None
481
# get revision
482
if len(args) > 1:
483
revision_id = args[1]
484
else:
485
revision_id = kwargs.get('revision', None)
486
# get location
487
if len(args):
488
url = args[0]
489
else:
490
# no default to raise if not provided.
491
url = kwargs.get('to_location')
492
return self.bzrdir.clone(url,
493
revision_id=revision_id,
494
basis=basis).open_branch()
495
# new cleaner api.
496
# generate args by hand
497
if len(args) > 1:
498
revision_id = args[1]
499
else:
500
revision_id = kwargs.get('revision_id', None)
501
if len(args):
502
to_bzrdir = args[0]
503
else:
504
# no default to raise if not provided.
505
to_bzrdir = kwargs.get('to_bzrdir')
506
result = self._format.initialize(to_bzrdir)
507
self.copy_content_into(result, revision_id=revision_id)
508
return result
509
510
@needs_read_lock
511
def sprout(self, to_bzrdir, revision_id=None):
512
"""Create a new line of development from the branch, into to_bzrdir.
513
514
revision_id: if not None, the revision history in the new branch will
515
be truncated to end with revision_id.
516
"""
517
result = self._format.initialize(to_bzrdir)
518
self.copy_content_into(result, revision_id=revision_id)
519
result.set_parent(self.bzrdir.root_transport.base)
520
return result
521
522
@needs_read_lock
523
def copy_content_into(self, destination, revision_id=None):
524
"""Copy the content of self into destination.
525
526
revision_id: if not None, the revision history in the new branch will
527
be truncated to end with revision_id.
528
"""
529
new_history = self.revision_history()
530
if revision_id is not None:
531
try:
532
new_history = new_history[:new_history.index(revision_id) + 1]
533
except ValueError:
534
rev = self.repository.get_revision(revision_id)
535
new_history = rev.get_history(self.repository)[1:]
536
destination.set_revision_history(new_history)
537
parent = self.get_parent()
538
if parent:
539
destination.set_parent(parent)
540
541
542
class BranchFormat(object):
543
"""An encapsulation of the initialization and open routines for a format.
544
545
Formats provide three things:
546
* An initialization routine,
547
* a format string,
548
* an open routine.
549
550
Formats are placed in an dict by their format string for reference
551
during branch opening. Its not required that these be instances, they
552
can be classes themselves with class methods - it simply depends on
553
whether state is needed for a given format or not.
554
555
Once a format is deprecated, just deprecate the initialize and open
556
methods on the format class. Do not deprecate the object, as the
557
object will be created every time regardless.
558
"""
559
560
_default_format = None
561
"""The default format used for new branches."""
562
563
_formats = {}
564
"""The known formats."""
565
566
@classmethod
567
def find_format(klass, a_bzrdir):
568
"""Return the format for the branch object in a_bzrdir."""
569
try:
570
transport = a_bzrdir.get_branch_transport(None)
571
format_string = transport.get("format").read()
572
return klass._formats[format_string]
573
except NoSuchFile:
574
raise NotBranchError(path=transport.base)
575
except KeyError:
576
raise errors.UnknownFormatError(format_string)
577
578
@classmethod
579
def get_default_format(klass):
580
"""Return the current default format."""
581
return klass._default_format
582
583
def get_format_string(self):
584
"""Return the ASCII format string that identifies this format."""
585
raise NotImplementedError(self.get_format_string)
586
587
def get_format_description(self):
588
"""Return the short format description for this format."""
589
raise NotImplementedError(self.get_format_string)
590
591
def initialize(self, a_bzrdir):
592
"""Create a branch of this format in a_bzrdir."""
593
raise NotImplementedError(self.initialized)
594
595
def is_supported(self):
596
"""Is this format supported?
597
598
Supported formats can be initialized and opened.
599
Unsupported formats may not support initialization or committing or
600
some other features depending on the reason for not being supported.
601
"""
602
return True
603
604
def open(self, a_bzrdir, _found=False):
605
"""Return the branch object for a_bzrdir
606
607
_found is a private parameter, do not use it. It is used to indicate
608
if format probing has already be done.
609
"""
610
raise NotImplementedError(self.open)
611
612
@classmethod
613
def register_format(klass, format):
614
klass._formats[format.get_format_string()] = format
615
616
@classmethod
617
def set_default_format(klass, format):
618
klass._default_format = format
619
620
@classmethod
621
def unregister_format(klass, format):
622
assert klass._formats[format.get_format_string()] is format
623
del klass._formats[format.get_format_string()]
624
625
def __str__(self):
626
return self.get_format_string().rstrip()
627
628
629
class BzrBranchFormat4(BranchFormat):
630
"""Bzr branch format 4.
631
632
This format has:
633
- a revision-history file.
634
- a branch-lock lock file [ to be shared with the bzrdir ]
635
"""
636
637
def get_format_description(self):
638
"""See BranchFormat.get_format_description()."""
639
return "Branch format 4"
640
641
def initialize(self, a_bzrdir):
642
"""Create a branch of this format in a_bzrdir."""
643
mutter('creating branch in %s', a_bzrdir.transport.base)
644
branch_transport = a_bzrdir.get_branch_transport(self)
645
utf8_files = [('revision-history', ''),
646
('branch-name', ''),
647
]
648
control_files = LockableFiles(branch_transport, 'branch-lock',
649
TransportLock)
650
control_files.create_lock()
651
control_files.lock_write()
652
try:
653
for file, content in utf8_files:
654
control_files.put_utf8(file, content)
655
finally:
656
control_files.unlock()
657
return self.open(a_bzrdir, _found=True)
658
659
def __init__(self):
660
super(BzrBranchFormat4, self).__init__()
661
self._matchingbzrdir = bzrdir.BzrDirFormat6()
662
663
def open(self, a_bzrdir, _found=False):
664
"""Return the branch object for a_bzrdir
665
666
_found is a private parameter, do not use it. It is used to indicate
667
if format probing has already be done.
668
"""
669
if not _found:
670
# we are being called directly and must probe.
671
raise NotImplementedError
672
return BzrBranch(_format=self,
673
_control_files=a_bzrdir._control_files,
674
a_bzrdir=a_bzrdir,
675
_repository=a_bzrdir.open_repository())
676
677
def __str__(self):
678
return "Bazaar-NG branch format 4"
679
680
681
class BzrBranchFormat5(BranchFormat):
682
"""Bzr branch format 5.
683
684
This format has:
685
- a revision-history file.
686
- a format string
687
- a lock dir guarding the branch itself
688
- all of this stored in a branch/ subdirectory
689
- works with shared repositories.
690
691
This format is new in bzr 0.8.
692
"""
693
694
def get_format_string(self):
695
"""See BranchFormat.get_format_string()."""
696
return "Bazaar-NG branch format 5\n"
697
698
def get_format_description(self):
699
"""See BranchFormat.get_format_description()."""
700
return "Branch format 5"
701
702
def initialize(self, a_bzrdir):
703
"""Create a branch of this format in a_bzrdir."""
704
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
705
branch_transport = a_bzrdir.get_branch_transport(self)
706
utf8_files = [('revision-history', ''),
707
('branch-name', ''),
708
]
709
control_files = LockableFiles(branch_transport, 'lock', LockDir)
710
control_files.create_lock()
711
control_files.lock_write()
712
control_files.put_utf8('format', self.get_format_string())
713
try:
714
for file, content in utf8_files:
715
control_files.put_utf8(file, content)
716
finally:
717
control_files.unlock()
718
return self.open(a_bzrdir, _found=True, )
719
720
def __init__(self):
721
super(BzrBranchFormat5, self).__init__()
722
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
723
724
def open(self, a_bzrdir, _found=False):
725
"""Return the branch object for a_bzrdir
726
727
_found is a private parameter, do not use it. It is used to indicate
728
if format probing has already be done.
729
"""
730
if not _found:
731
format = BranchFormat.find_format(a_bzrdir)
732
assert format.__class__ == self.__class__
733
transport = a_bzrdir.get_branch_transport(None)
734
control_files = LockableFiles(transport, 'lock', LockDir)
735
return BzrBranch5(_format=self,
736
_control_files=control_files,
737
a_bzrdir=a_bzrdir,
738
_repository=a_bzrdir.find_repository())
739
740
def __str__(self):
741
return "Bazaar-NG Metadir branch format 5"
742
743
744
class BranchReferenceFormat(BranchFormat):
745
"""Bzr branch reference format.
746
747
Branch references are used in implementing checkouts, they
748
act as an alias to the real branch which is at some other url.
749
750
This format has:
751
- A location file
752
- a format string
753
"""
754
755
def get_format_string(self):
756
"""See BranchFormat.get_format_string()."""
757
return "Bazaar-NG Branch Reference Format 1\n"
758
759
def get_format_description(self):
760
"""See BranchFormat.get_format_description()."""
761
return "Checkout reference format 1"
762
763
def initialize(self, a_bzrdir, target_branch=None):
764
"""Create a branch of this format in a_bzrdir."""
765
if target_branch is None:
766
# this format does not implement branch itself, thus the implicit
767
# creation contract must see it as uninitializable
768
raise errors.UninitializableFormat(self)
769
mutter('creating branch reference in %s', a_bzrdir.transport.base)
770
branch_transport = a_bzrdir.get_branch_transport(self)
771
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
772
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
773
branch_transport.put('format', StringIO(self.get_format_string()))
774
return self.open(a_bzrdir, _found=True)
775
776
def __init__(self):
777
super(BranchReferenceFormat, self).__init__()
778
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
779
780
def _make_reference_clone_function(format, a_branch):
781
"""Create a clone() routine for a branch dynamically."""
782
def clone(to_bzrdir, revision_id=None):
783
"""See Branch.clone()."""
784
return format.initialize(to_bzrdir, a_branch)
785
# cannot obey revision_id limits when cloning a reference ...
786
# FIXME RBC 20060210 either nuke revision_id for clone, or
787
# emit some sort of warning/error to the caller ?!
788
return clone
789
790
def open(self, a_bzrdir, _found=False):
791
"""Return the branch that the branch reference in a_bzrdir points at.
792
793
_found is a private parameter, do not use it. It is used to indicate
794
if format probing has already be done.
795
"""
796
if not _found:
797
format = BranchFormat.find_format(a_bzrdir)
798
assert format.__class__ == self.__class__
799
transport = a_bzrdir.get_branch_transport(None)
800
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
801
result = real_bzrdir.open_branch()
802
# this changes the behaviour of result.clone to create a new reference
803
# rather than a copy of the content of the branch.
804
# I did not use a proxy object because that needs much more extensive
805
# testing, and we are only changing one behaviour at the moment.
806
# If we decide to alter more behaviours - i.e. the implicit nickname
807
# then this should be refactored to introduce a tested proxy branch
808
# and a subclass of that for use in overriding clone() and ....
809
# - RBC 20060210
810
result.clone = self._make_reference_clone_function(result)
811
return result
812
813
814
# formats which have no format string are not discoverable
815
# and not independently creatable, so are not registered.
816
__default_format = BzrBranchFormat5()
817
BranchFormat.register_format(__default_format)
818
BranchFormat.register_format(BranchReferenceFormat())
819
BranchFormat.set_default_format(__default_format)
820
_legacy_formats = [BzrBranchFormat4(),
821
]
822
823
class BzrBranch(Branch):
824
"""A branch stored in the actual filesystem.
825
826
Note that it's "local" in the context of the filesystem; it doesn't
827
really matter if it's on an nfs/smb/afs/coda/... share, as long as
828
it's writable, and can be accessed via the normal filesystem API.
829
"""
830
831
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
832
relax_version_check=DEPRECATED_PARAMETER, _format=None,
833
_control_files=None, a_bzrdir=None, _repository=None):
834
"""Create new branch object at a particular location.
835
836
transport -- A Transport object, defining how to access files.
837
838
init -- If True, create new control files in a previously
839
unversioned directory. If False, the branch must already
840
be versioned.
841
842
relax_version_check -- If true, the usual check for the branch
843
version is not applied. This is intended only for
844
upgrade/recovery type use; it's not guaranteed that
845
all operations will work on old format branches.
846
"""
847
if a_bzrdir is None:
848
self.bzrdir = bzrdir.BzrDir.open(transport.base)
849
else:
850
self.bzrdir = a_bzrdir
851
self._transport = self.bzrdir.transport.clone('..')
852
self._base = self._transport.base
853
self._format = _format
854
if _control_files is None:
855
raise BzrBadParameterMissing('_control_files')
856
self.control_files = _control_files
857
if deprecated_passed(init):
858
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
859
"deprecated as of bzr 0.8. Please use Branch.create().",
860
DeprecationWarning,
861
stacklevel=2)
862
if init:
863
# this is slower than before deprecation, oh well never mind.
864
# -> its deprecated.
865
self._initialize(transport.base)
866
self._check_format(_format)
867
if deprecated_passed(relax_version_check):
868
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
869
"relax_version_check parameter is deprecated as of bzr 0.8. "
870
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
871
"open() method.",
872
DeprecationWarning,
873
stacklevel=2)
874
if (not relax_version_check
875
and not self._format.is_supported()):
876
raise errors.UnsupportedFormatError(
877
'sorry, branch format %r not supported' % fmt,
878
['use a different bzr version',
879
'or remove the .bzr directory'
880
' and "bzr init" again'])
881
if deprecated_passed(transport):
882
warn("BzrBranch.__init__(transport=XXX...): The transport "
883
"parameter is deprecated as of bzr 0.8. "
884
"Please use Branch.open, or bzrdir.open_branch().",
885
DeprecationWarning,
886
stacklevel=2)
887
self.repository = _repository
888
889
def __str__(self):
890
return '%s(%r)' % (self.__class__.__name__, self.base)
891
892
__repr__ = __str__
893
894
def __del__(self):
895
# TODO: It might be best to do this somewhere else,
896
# but it is nice for a Branch object to automatically
897
# cache it's information.
898
# Alternatively, we could have the Transport objects cache requests
899
# See the earlier discussion about how major objects (like Branch)
900
# should never expect their __del__ function to run.
901
# XXX: cache_root seems to be unused, 2006-01-13 mbp
902
if hasattr(self, 'cache_root') and self.cache_root is not None:
903
try:
904
rmtree(self.cache_root)
905
except:
906
pass
907
self.cache_root = None
908
909
def _get_base(self):
910
return self._base
911
912
base = property(_get_base, doc="The URL for the root of this branch.")
913
914
def _finish_transaction(self):
915
"""Exit the current transaction."""
916
return self.control_files._finish_transaction()
917
918
def get_transaction(self):
919
"""Return the current active transaction.
920
921
If no transaction is active, this returns a passthrough object
922
for which all data is immediately flushed and no caching happens.
923
"""
924
# this is an explicit function so that we can do tricky stuff
925
# when the storage in rev_storage is elsewhere.
926
# we probably need to hook the two 'lock a location' and
927
# 'have a transaction' together more delicately, so that
928
# we can have two locks (branch and storage) and one transaction
929
# ... and finishing the transaction unlocks both, but unlocking
930
# does not. - RBC 20051121
931
return self.control_files.get_transaction()
932
933
def _set_transaction(self, transaction):
934
"""Set a new active transaction."""
935
return self.control_files._set_transaction(transaction)
936
937
def abspath(self, name):
938
"""See Branch.abspath."""
939
return self.control_files._transport.abspath(name)
940
941
def _check_format(self, format):
942
"""Identify the branch format if needed.
943
944
The format is stored as a reference to the format object in
945
self._format for code that needs to check it later.
946
947
The format parameter is either None or the branch format class
948
used to open this branch.
949
950
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
951
"""
952
if format is None:
953
format = BzrBranchFormat.find_format(self.bzrdir)
954
self._format = format
955
mutter("got branch format %s", self._format)
956
957
@needs_read_lock
958
def get_root_id(self):
959
"""See Branch.get_root_id."""
960
tree = self.repository.revision_tree(self.last_revision())
961
return tree.inventory.root.file_id
962
963
def is_locked(self):
964
return self.control_files.is_locked()
965
966
def lock_write(self):
967
# TODO: test for failed two phase locks. This is known broken.
968
self.control_files.lock_write()
969
self.repository.lock_write()
970
971
def lock_read(self):
972
# TODO: test for failed two phase locks. This is known broken.
973
self.control_files.lock_read()
974
self.repository.lock_read()
975
976
def unlock(self):
977
# TODO: test for failed two phase locks. This is known broken.
978
try:
979
self.repository.unlock()
980
finally:
981
self.control_files.unlock()
982
983
def peek_lock_mode(self):
984
if self.control_files._lock_count == 0:
985
return None
986
else:
987
return self.control_files._lock_mode
988
989
def get_physical_lock_status(self):
990
return self.control_files.get_physical_lock_status()
991
992
@needs_read_lock
993
def print_file(self, file, revision_id):
994
"""See Branch.print_file."""
995
return self.repository.print_file(file, revision_id)
996
997
@needs_write_lock
998
def append_revision(self, *revision_ids):
999
"""See Branch.append_revision."""
1000
for revision_id in revision_ids:
1001
mutter("add {%s} to revision-history" % revision_id)
1002
rev_history = self.revision_history()
1003
rev_history.extend(revision_ids)
1004
self.set_revision_history(rev_history)
1005
1006
@needs_write_lock
1007
def set_revision_history(self, rev_history):
1008
"""See Branch.set_revision_history."""
1009
self.control_files.put_utf8(
1010
'revision-history', '\n'.join(rev_history))
1011
transaction = self.get_transaction()
1012
history = transaction.map.find_revision_history()
1013
if history is not None:
1014
# update the revision history in the identity map.
1015
history[:] = list(rev_history)
1016
# this call is disabled because revision_history is
1017
# not really an object yet, and the transaction is for objects.
1018
# transaction.register_dirty(history)
1019
else:
1020
transaction.map.add_revision_history(rev_history)
1021
# this call is disabled because revision_history is
1022
# not really an object yet, and the transaction is for objects.
1023
# transaction.register_clean(history)
1024
1025
def get_revision_delta(self, revno):
1026
"""Return the delta for one revision.
1027
1028
The delta is relative to its mainline predecessor, or the
1029
empty tree for revision 1.
1030
"""
1031
assert isinstance(revno, int)
1032
rh = self.revision_history()
1033
if not (1 <= revno <= len(rh)):
1034
raise InvalidRevisionNumber(revno)
1035
1036
# revno is 1-based; list is 0-based
1037
1038
new_tree = self.repository.revision_tree(rh[revno-1])
1039
if revno == 1:
1040
old_tree = EmptyTree()
1041
else:
1042
old_tree = self.repository.revision_tree(rh[revno-2])
1043
return compare_trees(old_tree, new_tree)
1044
1045
@needs_read_lock
1046
def revision_history(self):
1047
"""See Branch.revision_history."""
1048
transaction = self.get_transaction()
1049
history = transaction.map.find_revision_history()
1050
if history is not None:
1051
mutter("cache hit for revision-history in %s", self)
1052
return list(history)
1053
history = [l.rstrip('\r\n') for l in
1054
self.control_files.get_utf8('revision-history').readlines()]
1055
transaction.map.add_revision_history(history)
1056
# this call is disabled because revision_history is
1057
# not really an object yet, and the transaction is for objects.
1058
# transaction.register_clean(history, precious=True)
1059
return list(history)
1060
1061
@needs_write_lock
1062
def update_revisions(self, other, stop_revision=None):
1063
"""See Branch.update_revisions."""
1064
other.lock_read()
1065
try:
1066
if stop_revision is None:
1067
stop_revision = other.last_revision()
1068
if stop_revision is None:
1069
# if there are no commits, we're done.
1070
return
1071
# whats the current last revision, before we fetch [and change it
1072
# possibly]
1073
last_rev = self.last_revision()
1074
# we fetch here regardless of whether we need to so that we pickup
1075
# filled in ghosts.
1076
self.fetch(other, stop_revision)
1077
my_ancestry = self.repository.get_ancestry(last_rev)
1078
if stop_revision in my_ancestry:
1079
# last_revision is a descendant of stop_revision
1080
return
1081
# stop_revision must be a descendant of last_revision
1082
stop_graph = self.repository.get_revision_graph(stop_revision)
1083
if last_rev is not None and last_rev not in stop_graph:
1084
# our previous tip is not merged into stop_revision
1085
raise errors.DivergedBranches(self, other)
1086
# make a new revision history from the graph
1087
current_rev_id = stop_revision
1088
new_history = []
1089
while current_rev_id not in (None, NULL_REVISION):
1090
new_history.append(current_rev_id)
1091
current_rev_id_parents = stop_graph[current_rev_id]
1092
try:
1093
current_rev_id = current_rev_id_parents[0]
1094
except IndexError:
1095
current_rev_id = None
1096
new_history.reverse()
1097
self.set_revision_history(new_history)
1098
finally:
1099
other.unlock()
1100
1101
@deprecated_method(zero_eight)
1102
def pullable_revisions(self, other, stop_revision):
1103
"""Please use bzrlib.missing instead."""
1104
other_revno = other.revision_id_to_revno(stop_revision)
1105
try:
1106
return self.missing_revisions(other, other_revno)
1107
except DivergedBranches, e:
1108
try:
1109
pullable_revs = get_intervening_revisions(self.last_revision(),
1110
stop_revision,
1111
self.repository)
1112
assert self.last_revision() not in pullable_revs
1113
return pullable_revs
1114
except bzrlib.errors.NotAncestor:
1115
if is_ancestor(self.last_revision(), stop_revision, self):
1116
return []
1117
else:
1118
raise e
1119
1120
def basis_tree(self):
1121
"""See Branch.basis_tree."""
1122
return self.repository.revision_tree(self.last_revision())
1123
1124
@deprecated_method(zero_eight)
1125
def working_tree(self):
1126
"""Create a Working tree object for this branch."""
1127
from bzrlib.workingtree import WorkingTree
1128
from bzrlib.transport.local import LocalTransport
1129
if (self.base.find('://') != -1 or
1130
not isinstance(self._transport, LocalTransport)):
1131
raise NoWorkingTree(self.base)
1132
return self.bzrdir.open_workingtree()
1133
1134
@needs_write_lock
1135
def pull(self, source, overwrite=False, stop_revision=None):
1136
"""See Branch.pull."""
1137
source.lock_read()
1138
try:
1139
old_count = len(self.revision_history())
1140
try:
1141
self.update_revisions(source,stop_revision)
1142
except DivergedBranches:
1143
if not overwrite:
1144
raise
1145
if overwrite:
1146
self.set_revision_history(source.revision_history())
1147
new_count = len(self.revision_history())
1148
return new_count - old_count
1149
finally:
1150
source.unlock()
1151
1152
def get_parent(self):
1153
"""See Branch.get_parent."""
1154
import errno
1155
_locs = ['parent', 'pull', 'x-pull']
1156
for l in _locs:
1157
try:
1158
return self.control_files.get_utf8(l).read().strip('\n')
1159
except NoSuchFile:
1160
pass
1161
return None
1162
1163
def get_push_location(self):
1164
"""See Branch.get_push_location."""
1165
config = bzrlib.config.BranchConfig(self)
1166
push_loc = config.get_user_option('push_location')
1167
return push_loc
1168
1169
def set_push_location(self, location):
1170
"""See Branch.set_push_location."""
1171
config = bzrlib.config.LocationConfig(self.base)
1172
config.set_user_option('push_location', location)
1173
1174
@needs_write_lock
1175
def set_parent(self, url):
1176
"""See Branch.set_parent."""
1177
# TODO: Maybe delete old location files?
1178
# URLs should never be unicode, even on the local fs,
1179
# FIXUP this and get_parent in a future branch format bump:
1180
# read and rewrite the file, and have the new format code read
1181
# using .get not .get_utf8. RBC 20060125
1182
if url is None:
1183
self.control_files._transport.delete('parent')
1184
else:
1185
self.control_files.put_utf8('parent', url + '\n')
1186
1187
def tree_config(self):
1188
return TreeConfig(self)
1189
1190
1191
class BzrBranch5(BzrBranch):
1192
"""A format 5 branch. This supports new features over plan branches.
1193
1194
It has support for a master_branch which is the data for bound branches.
1195
"""
1196
1197
def __init__(self,
1198
_format,
1199
_control_files,
1200
a_bzrdir,
1201
_repository):
1202
super(BzrBranch5, self).__init__(_format=_format,
1203
_control_files=_control_files,
1204
a_bzrdir=a_bzrdir,
1205
_repository=_repository)
1206
1207
@needs_write_lock
1208
def pull(self, source, overwrite=False, stop_revision=None):
1209
"""Updates branch.pull to be bound branch aware."""
1210
bound_location = self.get_bound_location()
1211
if source.base != bound_location:
1212
# not pulling from master, so we need to update master.
1213
master_branch = self.get_master_branch()
1214
if master_branch:
1215
master_branch.pull(source)
1216
source = master_branch
1217
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1218
1219
def get_bound_location(self):
1220
try:
1221
return self.control_files.get_utf8('bound').read()[:-1]
1222
except errors.NoSuchFile:
1223
return None
1224
1225
@needs_read_lock
1226
def get_master_branch(self):
1227
"""Return the branch we are bound to.
1228
1229
:return: Either a Branch, or None
1230
1231
This could memoise the branch, but if thats done
1232
it must be revalidated on each new lock.
1233
So for now we just dont memoise it.
1234
# RBC 20060304 review this decision.
1235
"""
1236
bound_loc = self.get_bound_location()
1237
if not bound_loc:
1238
return None
1239
try:
1240
return Branch.open(bound_loc)
1241
except (errors.NotBranchError, errors.ConnectionError), e:
1242
raise errors.BoundBranchConnectionFailure(
1243
self, bound_loc, e)
1244
1245
@needs_write_lock
1246
def set_bound_location(self, location):
1247
"""Set the target where this branch is bound to.
1248
1249
:param location: URL to the target branch
1250
"""
1251
if location:
1252
self.control_files.put_utf8('bound', location+'\n')
1253
else:
1254
try:
1255
self.control_files._transport.delete('bound')
1256
except NoSuchFile:
1257
return False
1258
return True
1259
1260
@needs_write_lock
1261
def bind(self, other):
1262
"""Bind the local branch the other branch.
1263
1264
:param other: The branch to bind to
1265
:type other: Branch
1266
"""
1267
# TODO: jam 20051230 Consider checking if the target is bound
1268
# It is debatable whether you should be able to bind to
1269
# a branch which is itself bound.
1270
# Committing is obviously forbidden,
1271
# but binding itself may not be.
1272
# Since we *have* to check at commit time, we don't
1273
# *need* to check here
1274
self.pull(other)
1275
1276
# we are now equal to or a suffix of other.
1277
1278
# Since we have 'pulled' from the remote location,
1279
# now we should try to pull in the opposite direction
1280
# in case the local tree has more revisions than the
1281
# remote one.
1282
# There may be a different check you could do here
1283
# rather than actually trying to install revisions remotely.
1284
# TODO: capture an exception which indicates the remote branch
1285
# is not writeable.
1286
# If it is up-to-date, this probably should not be a failure
1287
1288
# lock other for write so the revision-history syncing cannot race
1289
other.lock_write()
1290
try:
1291
other.pull(self)
1292
# if this does not error, other now has the same last rev we do
1293
# it can only error if the pull from other was concurrent with
1294
# a commit to other from someone else.
1295
1296
# until we ditch revision-history, we need to sync them up:
1297
self.set_revision_history(other.revision_history())
1298
# now other and self are up to date with each other and have the
1299
# same revision-history.
1300
finally:
1301
other.unlock()
1302
1303
self.set_bound_location(other.base)
1304
1305
@needs_write_lock
1306
def unbind(self):
1307
"""If bound, unbind"""
1308
return self.set_bound_location(None)
1309
1310
@needs_write_lock
1311
def update(self):
1312
"""Synchronise this branch with the master branch if any.
1313
1314
:return: None or the last_revision that was pivoted out during the
1315
update.
1316
"""
1317
master = self.get_master_branch()
1318
if master is not None:
1319
old_tip = self.last_revision()
1320
self.pull(master, overwrite=True)
1321
if old_tip in self.repository.get_ancestry(self.last_revision()):
1322
return None
1323
return old_tip
1324
return None
1325
1326
1327
class BranchTestProviderAdapter(object):
1328
"""A tool to generate a suite testing multiple branch formats at once.
1329
1330
This is done by copying the test once for each transport and injecting
1331
the transport_server, transport_readonly_server, and branch_format
1332
classes into each copy. Each copy is also given a new id() to make it
1333
easy to identify.
1334
"""
1335
1336
def __init__(self, transport_server, transport_readonly_server, formats):
1337
self._transport_server = transport_server
1338
self._transport_readonly_server = transport_readonly_server
1339
self._formats = formats
1340
1341
def adapt(self, test):
1342
result = TestSuite()
1343
for branch_format, bzrdir_format in self._formats:
1344
new_test = deepcopy(test)
1345
new_test.transport_server = self._transport_server
1346
new_test.transport_readonly_server = self._transport_readonly_server
1347
new_test.bzrdir_format = bzrdir_format
1348
new_test.branch_format = branch_format
1349
def make_new_test_id():
1350
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1351
return lambda: new_id
1352
new_test.id = make_new_test_id()
1353
result.addTest(new_test)
1354
return result
1355
1263
1356
1264
1357
######################################################################
1265
1358
# predicates
1266
1359
1267
1360
1268
def is_control_file(filename):
1269
## FIXME: better check
1270
filename = os.path.normpath(filename)
1271
while filename != '':
1272
head, tail = os.path.split(filename)
1273
## mutter('check %r for control file' % ((head, tail), ))
1274
if tail == bzrlib.BZRDIR:
1275
return True
1276
if filename == head:
1277
break
1278
filename = head
1279
return False
1280
1281
1282
1283
def gen_file_id(name):
1284
"""Return new file id.
1285
1286
This should probably generate proper UUIDs, but for the moment we
1287
cope with just randomness because running uuidgen every time is
1288
slow."""
1289
import re
1290
from binascii import hexlify
1291
from time import time
1292
1293
# get last component
1294
idx = name.rfind('/')
1295
if idx != -1:
1296
name = name[idx+1 : ]
1297
idx = name.rfind('\\')
1298
if idx != -1:
1299
name = name[idx+1 : ]
1300
1301
# make it not a hidden file
1302
name = name.lstrip('.')
1303
1304
# remove any wierd characters; we don't escape them but rather
1305
# just pull them out
1306
name = re.sub(r'[^\w.]', '', name)
1307
1308
s = hexlify(rand_bytes(8))
1309
return '-'.join((name, compact_date(time()), s))
1310
1311
1312
def gen_root_id():
1313
"""Return a new tree-root file id."""
1314
return gen_file_id('TREE_ROOT')
1315
1316
1361
@deprecated_function(zero_eight)
1362
def ScratchBranch(*args, **kwargs):
1363
"""See bzrlib.bzrdir.ScratchDir."""
1364
d = ScratchDir(*args, **kwargs)
1365
return d.open_branch()
1366
1367
1368
@deprecated_function(zero_eight)
1369
def is_control_file(*args, **kwargs):
1370
"""See bzrlib.workingtree.is_control_file."""
1371
return bzrlib.workingtree.is_control_file(*args, **kwargs)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1