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