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