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