« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1534.3.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1534.3.1
- Committer: Robert Collins
- Date: 2006-01-05 22:30:59 UTC
- mto: (1534.1.4 integration)
- mto: This revision was merged to the branch mainline in revision 1536.
- Revision ID: robertc@robertcollins.net-20060105223059-a8b64f7b47cf12fb
* bzrlib.osutils.safe_unicode now exists to provide parameter coercion
for functions that need unicode strings. (Robert Collins)
for functions that need unicode strings. (Robert Collins)
- files added:
- BRANCH.TODO
- bzrlib/export
- bzrlib/store
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- files removed:
- bzrlib/mdiff.py
- files renamed:
- bzr-man.py => bzr_man.py
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/weavestore.py => bzrlib/store/weave.py
- bzrlib/selftest/ => bzrlib/tests/
- 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/test_branch.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.py
- bzrlib/selftest/testfetch.py => bzrlib/tests/test_fetch.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/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/teststatus.py => bzrlib/tests/test_status.py
- bzrlib/selftest/teststore.py => bzrlib/tests/test_store.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- bzrlib/ui.py => bzrlib/ui/__init__.py
- tools/history2weaves.py => bzrlib/upgrade.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
import shutil
18
19
import sys
19
20
import os
21
import errno
22
from warnings import warn
20
23
from cStringIO import StringIO
21
24
25
22
26
import bzrlib
27
import bzrlib.inventory as inventory
23
28
from bzrlib.trace import mutter, note
24
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
splitpath, \
26
sha_file, appendpath, file_kind
27
29
from bzrlib.osutils import (isdir, quotefn,
30
rename, splitpath, sha_file,
31
file_kind, abspath, normpath, pathjoin)
32
import bzrlib.errors as errors
28
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
29
NoSuchRevision)
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError,
37
NoWorkingTree)
30
38
from bzrlib.textui import show_status
31
from bzrlib.revision import Revision
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
40
NULL_REVISION)
41
32
42
from bzrlib.delta import compare_trees
33
43
from bzrlib.tree import EmptyTree, RevisionTree
34
44
from bzrlib.inventory import Inventory
35
from bzrlib.weavestore import WeaveStore
36
from bzrlib.store import ImmutableStore
45
from bzrlib.store import copy_all
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
37
51
import bzrlib.xml5
38
52
import bzrlib.ui
39
40
41
INVENTORY_FILEID = '__inventory'
42
ANCESTRY_FILEID = '__ancestry'
53
from config import TreeConfig
43
54
44
55
45
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
46
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
47
59
## TODO: Maybe include checks for common corruption of newlines, etc?
48
60
49
61
52
64
# cache in memory to make this faster. In general anything can be
53
65
# cached in memory between lock and unlock operations.
54
66
55
# TODO: please move the revision-string syntax stuff out of the branch
56
# object; it's clutter
57
58
59
def find_branch(f, **args):
60
if f and (f.startswith('http://') or f.startswith('https://')):
61
import remotebranch
62
return remotebranch.RemoteBranch(f, **args)
63
else:
64
return Branch(f, **args)
65
66
67
def find_cached_branch(f, cache_root, **args):
68
from remotebranch import RemoteBranch
69
br = find_branch(f, **args)
70
def cacheify(br, store_name):
71
from meta_store import CachedStore
72
cache_path = os.path.join(cache_root, store_name)
73
os.mkdir(cache_path)
74
new_store = CachedStore(getattr(br, store_name), cache_path)
75
setattr(br, store_name, new_store)
76
77
if isinstance(br, RemoteBranch):
78
cacheify(br, 'inventory_store')
79
cacheify(br, 'text_store')
80
cacheify(br, 'revision_store')
81
return br
82
83
84
def _relpath(base, path):
85
"""Return path relative to base, or raise exception.
86
87
The path may be either an absolute path or a path relative to the
88
current working directory.
89
90
Lifted out of Branch.relpath for ease of testing.
91
92
os.path.commonprefix (python2.4) has a bad bug that it works just
93
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
94
avoids that problem."""
95
rp = os.path.abspath(path)
96
97
s = []
98
head = rp
99
while len(head) >= len(base):
100
if head == base:
101
break
102
head, tail = os.path.split(head)
103
if tail:
104
s.insert(0, tail)
105
else:
106
from errors import NotBranchError
107
raise NotBranchError("path %r is not within branch %r" % (rp, base))
108
109
return os.sep.join(s)
110
111
112
def find_branch_root(f=None):
113
"""Find the branch root enclosing f, or pwd.
114
115
f may be a filename or a URL.
116
117
It is not necessary that f exists.
118
119
Basically we keep looking up until we find the control directory or
120
run into the root. If there isn't one, raises NotBranchError.
121
"""
122
if f == None:
123
f = os.getcwd()
124
elif hasattr(os.path, 'realpath'):
125
f = os.path.realpath(f)
126
else:
127
f = os.path.abspath(f)
128
if not os.path.exists(f):
129
raise BzrError('%r does not exist' % f)
130
131
132
orig_f = f
133
134
while True:
135
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
136
return f
137
head, tail = os.path.split(f)
138
if head == f:
139
# reached the root, whatever that may be
140
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
141
f = head
142
143
144
145
# XXX: move into bzrlib.errors; subclass BzrError
146
class DivergedBranches(Exception):
147
def __init__(self, branch1, branch2):
148
self.branch1 = branch1
149
self.branch2 = branch2
150
Exception.__init__(self, "These branches have diverged.")
151
67
def find_branch(*ignored, **ignored_too):
68
# XXX: leave this here for about one release, then remove it
69
raise NotImplementedError('find_branch() is not supported anymore, '
70
'please use one of the new branch constructors')
71
72
73
def needs_read_lock(unbound):
74
"""Decorate unbound to take out and release a read lock."""
75
def decorated(self, *args, **kwargs):
76
self.lock_read()
77
try:
78
return unbound(self, *args, **kwargs)
79
finally:
80
self.unlock()
81
return decorated
82
83
84
def needs_write_lock(unbound):
85
"""Decorate unbound to take out and release a write lock."""
86
def decorated(self, *args, **kwargs):
87
self.lock_write()
88
try:
89
return unbound(self, *args, **kwargs)
90
finally:
91
self.unlock()
92
return decorated
152
93
153
94
######################################################################
154
95
# branch objects
157
98
"""Branch holding a history of revisions.
158
99
159
100
base
160
Base directory of the branch.
161
162
_lock_mode
163
None, or 'r' or 'w'
164
165
_lock_count
166
If _lock_mode is true, a positive count of the number of times the
167
lock has been taken.
168
169
_lock
170
Lock object from bzrlib.lock.
101
Base directory/url of the branch.
171
102
"""
172
103
base = None
173
_lock_mode = None
174
_lock_count = None
175
_lock = None
176
_inventory_weave = None
177
178
# Map some sort of prefix into a namespace
179
# stuff like "revno:10", "revid:", etc.
180
# This should match a prefix with a function which accepts
181
REVISION_NAMESPACES = {}
182
183
def __init__(self, base, init=False, find_root=True):
184
"""Create new branch object at a particular location.
185
186
base -- Base directory for the branch.
187
188
init -- If True, create new control files in a previously
189
unversioned directory. If False, the branch must already
190
be versioned.
191
192
find_root -- If true and init is false, find the root of the
193
existing branch containing base.
194
195
In the test suite, creation of new trees is tested using the
196
`ScratchBranch` class.
197
"""
198
if init:
199
self.base = os.path.realpath(base)
200
self._make_control()
201
elif find_root:
202
self.base = find_branch_root(base)
203
else:
204
self.base = os.path.realpath(base)
205
if not isdir(self.controlfilename('.')):
206
from errors import NotBranchError
207
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
208
['use "bzr init" to initialize a new working tree',
209
'current bzr can only operate from top-of-tree'])
210
self._check_format()
211
212
self.weave_store = WeaveStore(self.controlfilename('weaves'))
213
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
214
215
216
def __str__(self):
217
return '%s(%r)' % (self.__class__.__name__, self.base)
218
219
220
__repr__ = __str__
221
222
223
def __del__(self):
224
if self._lock_mode or self._lock:
225
from warnings import warn
226
warn("branch %r was not explicitly unlocked" % self)
227
self._lock.unlock()
228
104
105
def __init__(self, *ignored, **ignored_too):
106
raise NotImplementedError('The Branch class is abstract')
107
108
@staticmethod
109
def open_downlevel(base):
110
"""Open a branch which may be of an old format.
111
112
Only local branches are supported."""
113
return BzrBranch(get_transport(base), relax_version_check=True)
114
115
@staticmethod
116
def open(base):
117
"""Open an existing branch, rooted at 'base' (url)"""
118
t = get_transport(base)
119
mutter("trying to open %r with transport %r", base, t)
120
return BzrBranch(t)
121
122
@staticmethod
123
def open_containing(url):
124
"""Open an existing branch which contains url.
125
126
This probes for a branch at url, and searches upwards from there.
127
128
Basically we keep looking up until we find the control directory or
129
run into the root. If there isn't one, raises NotBranchError.
130
If there is one, it is returned, along with the unused portion of url.
131
"""
132
t = get_transport(url)
133
while True:
134
try:
135
return BzrBranch(t), t.relpath(url)
136
except NotBranchError, e:
137
mutter('not a branch in: %r %s', t.base, e)
138
new_t = t.clone('..')
139
if new_t.base == t.base:
140
# reached the root, whatever that may be
141
raise NotBranchError(path=url)
142
t = new_t
143
144
@staticmethod
145
def initialize(base):
146
"""Create a new branch, rooted at 'base' (url)"""
147
t = get_transport(base)
148
return BzrBranch(t, init=True)
149
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
153
"""
154
self.cache_root = cache_root
155
156
def _get_nick(self):
157
cfg = self.tree_config()
158
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
159
160
def _set_nick(self, nick):
161
cfg = self.tree_config()
162
cfg.set_option(nick, "nickname")
163
assert cfg.get_option("nickname") == nick
164
165
nick = property(_get_nick, _set_nick)
166
167
def push_stores(self, branch_to):
168
"""Copy the content of this branches store to branch_to."""
169
raise NotImplementedError('push_stores is abstract')
170
171
def get_transaction(self):
172
"""Return the current active transaction.
173
174
If no transaction is active, this returns a passthrough object
175
for which all data is immediately flushed and no caching happens.
176
"""
177
raise NotImplementedError('get_transaction is abstract')
229
178
230
179
def lock_write(self):
231
if self._lock_mode:
232
if self._lock_mode != 'w':
233
from errors import LockError
234
raise LockError("can't upgrade to a write lock from %r" %
235
self._lock_mode)
236
self._lock_count += 1
237
else:
238
from bzrlib.lock import WriteLock
239
240
self._lock = WriteLock(self.controlfilename('branch-lock'))
241
self._lock_mode = 'w'
242
self._lock_count = 1
243
244
180
raise NotImplementedError('lock_write is abstract')
181
245
182
def lock_read(self):
246
if self._lock_mode:
247
assert self._lock_mode in ('r', 'w'), \
248
"invalid lock mode %r" % self._lock_mode
249
self._lock_count += 1
250
else:
251
from bzrlib.lock import ReadLock
183
raise NotImplementedError('lock_read is abstract')
252
184
253
self._lock = ReadLock(self.controlfilename('branch-lock'))
254
self._lock_mode = 'r'
255
self._lock_count = 1
256
257
185
def unlock(self):
258
if not self._lock_mode:
259
from errors import LockError
260
raise LockError('branch %r is not locked' % (self))
261
262
if self._lock_count > 1:
263
self._lock_count -= 1
264
else:
265
self._lock.unlock()
266
self._lock = None
267
self._lock_mode = self._lock_count = None
186
raise NotImplementedError('unlock is abstract')
268
187
269
188
def abspath(self, name):
270
"""Return absolute filename for something in the branch"""
271
return os.path.join(self.base, name)
272
273
def relpath(self, path):
274
"""Return path relative to this branch of something inside it.
275
276
Raises an error if path is not in this branch."""
277
return _relpath(self.base, path)
189
"""Return absolute filename for something in the branch
190
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
193
"""
194
raise NotImplementedError('abspath is abstract')
278
195
279
196
def controlfilename(self, file_or_path):
280
197
"""Return location relative to branch."""
281
if isinstance(file_or_path, basestring):
282
file_or_path = [file_or_path]
283
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
284
198
raise NotImplementedError('controlfilename is abstract')
285
199
286
200
def controlfile(self, file_or_path, mode='r'):
287
201
"""Open a control file for this branch.
294
208
Controlfiles should almost never be opened in write mode but
295
209
rather should be atomically copied and replaced using atomicfile.
296
210
"""
297
298
fn = self.controlfilename(file_or_path)
299
300
if mode == 'rb' or mode == 'wb':
301
return file(fn, mode)
302
elif mode == 'r' or mode == 'w':
303
# open in binary mode anyhow so there's no newline translation;
304
# codecs uses line buffering by default; don't want that.
305
import codecs
306
return codecs.open(fn, mode + 'b', 'utf-8',
307
buffering=60000)
308
else:
309
raise BzrError("invalid controlfile mode %r" % mode)
310
311
def _make_control(self):
312
os.mkdir(self.controlfilename([]))
313
self.controlfile('README', 'w').write(
314
"This is a Bazaar-NG control directory.\n"
315
"Do not change any files in this directory.\n")
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
for d in ('text-store', 'revision-store',
318
'weaves'):
319
os.mkdir(self.controlfilename(d))
320
for f in ('revision-history', 'merged-patches',
321
'pending-merged-patches', 'branch-name',
322
'branch-lock',
323
'pending-merges'):
324
self.controlfile(f, 'w').write('')
325
mutter('created control directory in ' + self.base)
326
327
# if we want per-tree root ids then this is the place to set
328
# them; they're not needed for now and so ommitted for
329
# simplicity.
330
f = self.controlfile('inventory','w')
331
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
332
333
334
335
def _check_format(self):
336
"""Check this branch format is supported.
337
338
The format level is stored, as an integer, in
339
self._branch_format for code that needs to check it later.
340
341
In the future, we might need different in-memory Branch
342
classes to support downlevel branches. But not yet.
343
"""
344
fmt = self.controlfile('branch-format', 'r').read()
345
if fmt == BZR_BRANCH_FORMAT_5:
346
self._branch_format = 5
347
else:
348
raise BzrError('sorry, branch format "%s" not supported; '
349
'use a different bzr version, '
350
'or run "bzr upgrade", '
351
'or remove the .bzr directory and "bzr init" again'
352
% fmt.rstrip('\n\r'))
211
raise NotImplementedError('controlfile is abstract')
212
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
215
216
:param path: The path to put the file, relative to the .bzr control
217
directory
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
220
"""
221
raise NotImplementedError('put_controlfile is abstract')
222
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
225
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
229
"""
230
raise NotImplementedError('put_controlfiles is abstract')
353
231
354
232
def get_root_id(self):
355
233
"""Return the id of this branches root"""
356
inv = self.read_working_inventory()
357
return inv.root.file_id
234
raise NotImplementedError('get_root_id is abstract')
358
235
359
236
def set_root_id(self, file_id):
360
inv = self.read_working_inventory()
361
orig_root_id = inv.root.file_id
362
del inv._byid[inv.root.file_id]
363
inv.root.file_id = file_id
364
inv._byid[inv.root.file_id] = inv.root
365
for fid in inv:
366
entry = inv[fid]
367
if entry.parent_id in (None, orig_root_id):
368
entry.parent_id = inv.root.file_id
369
self._write_inventory(inv)
370
371
def read_working_inventory(self):
372
"""Read the working inventory."""
373
self.lock_read()
374
try:
375
# ElementTree does its own conversion from UTF-8, so open in
376
# binary.
377
f = self.controlfile('inventory', 'rb')
378
return bzrlib.xml5.serializer_v5.read_inventory(f)
379
finally:
380
self.unlock()
381
382
383
def _write_inventory(self, inv):
384
"""Update the working inventory.
385
386
That is to say, the inventory describing changes underway, that
387
will be committed to the next revision.
388
"""
389
from bzrlib.atomicfile import AtomicFile
390
391
self.lock_write()
392
try:
393
f = AtomicFile(self.controlfilename('inventory'), 'wb')
394
try:
395
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
396
f.commit()
397
finally:
398
f.close()
399
finally:
400
self.unlock()
401
402
mutter('wrote working inventory')
403
404
405
inventory = property(read_working_inventory, _write_inventory, None,
406
"""Inventory for the working copy.""")
407
408
409
def add(self, files, ids=None):
410
"""Make files versioned.
411
412
Note that the command line normally calls smart_add instead,
413
which can automatically recurse.
414
415
This puts the files in the Added state, so that they will be
416
recorded by the next commit.
417
418
files
419
List of paths to add, relative to the base of the tree.
420
421
ids
422
If set, use these instead of automatically generated ids.
423
Must be the same length as the list of files, but may
424
contain None for ids that are to be autogenerated.
425
426
TODO: Perhaps have an option to add the ids even if the files do
427
not (yet) exist.
428
429
TODO: Perhaps yield the ids and paths as they're added.
430
"""
431
# TODO: Re-adding a file that is removed in the working copy
432
# should probably put it back with the previous ID.
433
if isinstance(files, basestring):
434
assert(ids is None or isinstance(ids, basestring))
435
files = [files]
436
if ids is not None:
437
ids = [ids]
438
439
if ids is None:
440
ids = [None] * len(files)
441
else:
442
assert(len(ids) == len(files))
443
444
self.lock_write()
445
try:
446
inv = self.read_working_inventory()
447
for f,file_id in zip(files, ids):
448
if is_control_file(f):
449
raise BzrError("cannot add control file %s" % quotefn(f))
450
451
fp = splitpath(f)
452
453
if len(fp) == 0:
454
raise BzrError("cannot add top-level %r" % f)
455
456
fullpath = os.path.normpath(self.abspath(f))
457
458
try:
459
kind = file_kind(fullpath)
460
except OSError:
461
# maybe something better?
462
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
463
464
if kind != 'file' and kind != 'directory':
465
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
467
if file_id is None:
468
file_id = gen_file_id(f)
469
inv.add_path(f, kind=kind, file_id=file_id)
470
471
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
472
473
self._write_inventory(inv)
474
finally:
475
self.unlock()
476
477
478
def print_file(self, file, revno):
237
raise NotImplementedError('set_root_id is abstract')
238
239
def print_file(self, file, revision_id):
479
240
"""Print `file` to stdout."""
480
self.lock_read()
481
try:
482
tree = self.revision_tree(self.lookup_revision(revno))
483
# use inventory as it was in that revision
484
file_id = tree.inventory.path2id(file)
485
if not file_id:
486
raise BzrError("%r is not present in revision %s" % (file, revno))
487
tree.print_file(file_id)
488
finally:
489
self.unlock()
490
491
492
def remove(self, files, verbose=False):
493
"""Mark nominated files for removal from the inventory.
494
495
This does not remove their text. This does not run on
496
497
TODO: Refuse to remove modified files unless --force is given?
498
499
TODO: Do something useful with directories.
500
501
TODO: Should this remove the text or not? Tough call; not
502
removing may be useful and the user can just use use rm, and
503
is the opposite of add. Removing it is consistent with most
504
other tools. Maybe an option.
505
"""
506
## TODO: Normalize names
507
## TODO: Remove nested loops; better scalability
508
if isinstance(files, basestring):
509
files = [files]
510
511
self.lock_write()
512
513
try:
514
tree = self.working_tree()
515
inv = tree.inventory
516
517
# do this before any modifications
518
for f in files:
519
fid = inv.path2id(f)
520
if not fid:
521
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
522
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
523
if verbose:
524
# having remove it, it must be either ignored or unknown
525
if tree.is_ignored(f):
526
new_status = 'I'
527
else:
528
new_status = '?'
529
show_status(new_status, inv[fid].kind, quotefn(f))
530
del inv[fid]
531
532
self._write_inventory(inv)
533
finally:
534
self.unlock()
535
536
537
# FIXME: this doesn't need to be a branch method
538
def set_inventory(self, new_inventory_list):
539
from bzrlib.inventory import Inventory, InventoryEntry
540
inv = Inventory(self.get_root_id())
541
for path, file_id, parent, kind in new_inventory_list:
542
name = os.path.basename(path)
543
if name == "":
544
continue
545
inv.add(InventoryEntry(file_id, name, kind, parent))
546
self._write_inventory(inv)
547
548
549
def unknowns(self):
550
"""Return all unknown files.
551
552
These are files in the working directory that are not versioned or
553
control files or ignored.
554
555
>>> b = ScratchBranch(files=['foo', 'foo~'])
556
>>> list(b.unknowns())
557
['foo']
558
>>> b.add('foo')
559
>>> list(b.unknowns())
560
[]
561
>>> b.remove('foo')
562
>>> list(b.unknowns())
563
['foo']
564
"""
565
return self.working_tree().unknowns()
566
241
raise NotImplementedError('print_file is abstract')
567
242
568
243
def append_revision(self, *revision_ids):
569
from bzrlib.atomicfile import AtomicFile
570
571
for revision_id in revision_ids:
572
mutter("add {%s} to revision-history" % revision_id)
573
574
rev_history = self.revision_history()
575
rev_history.extend(revision_ids)
576
577
f = AtomicFile(self.controlfilename('revision-history'))
578
try:
579
for rev_id in rev_history:
580
print >>f, rev_id
581
f.commit()
582
finally:
583
f.close()
584
585
586
def get_revision_xml_file(self, revision_id):
587
"""Return XML file object for revision object."""
588
if not revision_id or not isinstance(revision_id, basestring):
589
raise InvalidRevisionId(revision_id)
590
591
self.lock_read()
592
try:
593
try:
594
return self.revision_store[revision_id]
595
except IndexError:
596
raise bzrlib.errors.NoSuchRevision(self, revision_id)
597
finally:
598
self.unlock()
599
600
601
#deprecated
602
get_revision_xml = get_revision_xml_file
603
244
raise NotImplementedError('append_revision is abstract')
245
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
248
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
251
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
255
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
604
258
605
259
def get_revision(self, revision_id):
606
260
"""Return the Revision object for a named revision"""
607
xml_file = self.get_revision_xml_file(revision_id)
608
609
try:
610
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
611
except SyntaxError, e:
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
[revision_id,
614
str(e)])
615
616
assert r.revision_id == revision_id
617
return r
618
261
raise NotImplementedError('get_revision is abstract')
619
262
620
263
def get_revision_delta(self, revno):
621
264
"""Return the delta for one revision.
638
281
639
282
return compare_trees(old_tree, new_tree)
640
283
641
642
643
284
def get_revision_sha1(self, revision_id):
644
285
"""Hash the stored value of a revision, and return it."""
645
# In the future, revision entries will be signed. At that
646
# point, it is probably best *not* to include the signature
647
# in the revision hash. Because that lets you re-sign
648
# the revision, (add signatures/remove signatures) and still
649
# have all hash pointers stay consistent.
650
# But for now, just hash the contents.
651
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
652
286
raise NotImplementedError('get_revision_sha1 is abstract')
653
287
654
288
def get_ancestry(self, revision_id):
655
289
"""Return a list of revision-ids integrated by a revision.
290
291
This currently returns a list, but the ordering is not guaranteed:
292
treat it as a set.
656
293
"""
657
w = self.weave_store.get_weave(ANCESTRY_FILEID)
658
# strip newlines
659
return [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
660
661
662
def get_inventory_weave(self):
663
return self.weave_store.get_weave(INVENTORY_FILEID)
664
294
raise NotImplementedError('get_ancestry is abstract')
665
295
666
296
def get_inventory(self, revision_id):
667
297
"""Get Inventory object by hash."""
668
# FIXME: The text gets passed around a lot coming from the weave.
669
f = StringIO(self.get_inventory_xml(revision_id))
670
return bzrlib.xml5.serializer_v5.read_inventory(f)
671
298
raise NotImplementedError('get_inventory is abstract')
672
299
673
300
def get_inventory_xml(self, revision_id):
674
301
"""Get inventory XML as a file object."""
675
try:
676
assert isinstance(revision_id, basestring), type(revision_id)
677
iw = self.get_inventory_weave()
678
return iw.get_text(iw.lookup(revision_id))
679
except IndexError:
680
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
681
302
raise NotImplementedError('get_inventory_xml is abstract')
682
303
683
304
def get_inventory_sha1(self, revision_id):
684
"""Return the sha1 hash of the inventory entry
685
"""
686
return self.get_revision(revision_id).inventory_sha1
687
305
"""Return the sha1 hash of the inventory entry."""
306
raise NotImplementedError('get_inventory_sha1 is abstract')
688
307
689
308
def get_revision_inventory(self, revision_id):
690
309
"""Return inventory of a past revision."""
691
# bzr 0.0.6 and later imposes the constraint that the inventory_id
692
# must be the same as its revision, so this is trivial.
693
if revision_id == None:
694
return Inventory(self.get_root_id())
695
else:
696
return self.get_inventory(revision_id)
697
310
raise NotImplementedError('get_revision_inventory is abstract')
698
311
699
312
def revision_history(self):
700
"""Return sequence of revision hashes on to this branch.
701
702
>>> ScratchBranch().revision_history()
703
[]
704
"""
705
self.lock_read()
706
try:
707
return [l.rstrip('\r\n') for l in
708
self.controlfile('revision-history', 'r').readlines()]
709
finally:
710
self.unlock()
711
712
713
def common_ancestor(self, other, self_revno=None, other_revno=None):
714
"""
715
>>> import commit
716
>>> sb = ScratchBranch(files=['foo', 'foo~'])
717
>>> sb.common_ancestor(sb) == (None, None)
718
True
719
>>> commit.commit(sb, "Committing first revision")
720
>>> sb.common_ancestor(sb)[0]
721
1
722
>>> clone = sb.clone()
723
>>> commit.commit(sb, "Committing second revision")
724
>>> sb.common_ancestor(sb)[0]
725
2
726
>>> sb.common_ancestor(clone)[0]
727
1
728
>>> commit.commit(clone, "Committing divergent second revision")
729
>>> sb.common_ancestor(clone)[0]
730
1
731
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
732
True
733
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
734
True
735
>>> clone2 = sb.clone()
736
>>> sb.common_ancestor(clone2)[0]
737
2
738
>>> sb.common_ancestor(clone2, self_revno=1)[0]
739
1
740
>>> sb.common_ancestor(clone2, other_revno=1)[0]
741
1
742
"""
743
my_history = self.revision_history()
744
other_history = other.revision_history()
745
if self_revno is None:
746
self_revno = len(my_history)
747
if other_revno is None:
748
other_revno = len(other_history)
749
indices = range(min((self_revno, other_revno)))
750
indices.reverse()
751
for r in indices:
752
if my_history[r] == other_history[r]:
753
return r+1, my_history[r]
754
return None, None
755
313
"""Return sequence of revision hashes on to this branch."""
314
raise NotImplementedError('revision_history is abstract')
756
315
757
316
def revno(self):
758
317
"""Return current revision number for this branch.
762
321
"""
763
322
return len(self.revision_history())
764
323
765
766
def last_patch(self):
767
"""Return last patch hash, or None if no history.
768
"""
324
def last_revision(self):
325
"""Return last patch hash, or None if no history."""
769
326
ph = self.revision_history()
770
327
if ph:
771
328
return ph[-1]
772
329
else:
773
330
return None
774
331
775
776
332
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
777
"""
333
"""Return a list of new revisions that would perfectly fit.
334
778
335
If self and other have not diverged, return a list of the revisions
779
336
present in other, but missing from self.
780
337
798
355
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
799
356
>>> br1.missing_revisions(br2)
800
357
Traceback (most recent call last):
801
DivergedBranches: These branches have diverged.
358
DivergedBranches: These branches have diverged. Try merge.
802
359
"""
803
360
self_history = self.revision_history()
804
361
self_len = len(self_history)
811
368
812
369
if stop_revision is None:
813
370
stop_revision = other_len
814
elif stop_revision > other_len:
815
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
816
371
else:
372
assert isinstance(stop_revision, int)
373
if stop_revision > other_len:
374
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
817
375
return other_history[self_len:stop_revision]
818
819
376
820
377
def update_revisions(self, other, stop_revision=None):
821
"""Pull in all new revisions from other branch.
822
"""
823
from bzrlib.fetch import greedy_fetch
824
825
pb = bzrlib.ui.ui_factory.progress_bar()
826
pb.update('comparing histories')
827
828
revision_ids = self.missing_revisions(other, stop_revision)
829
830
if len(revision_ids) > 0:
831
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
832
else:
833
count = 0
834
self.append_revision(*revision_ids)
835
## note("Added %d revisions." % count)
836
pb.clear()
837
838
839
def commit(self, *args, **kw):
840
from bzrlib.commit import Commit
841
Commit().commit(self, *args, **kw)
378
"""Pull in new perfect-fit revisions."""
379
raise NotImplementedError('update_revisions is abstract')
380
381
def pullable_revisions(self, other, stop_revision):
382
raise NotImplementedError('pullable_revisions is abstract')
842
383
843
844
def lookup_revision(self, revision):
845
"""Return the revision identifier for a given revision information."""
846
revno, info = self._get_revision_info(revision)
847
return info
848
849
850
384
def revision_id_to_revno(self, revision_id):
851
385
"""Given a revision id, return its revno"""
386
if revision_id is None:
387
return 0
852
388
history = self.revision_history()
853
389
try:
854
390
return history.index(revision_id) + 1
855
391
except ValueError:
856
392
raise bzrlib.errors.NoSuchRevision(self, revision_id)
857
393
858
859
def get_revision_info(self, revision):
860
"""Return (revno, revision id) for revision identifier.
861
862
revision can be an integer, in which case it is assumed to be revno (though
863
this will translate negative values into positive ones)
864
revision can also be a string, in which case it is parsed for something like
865
'date:' or 'revid:' etc.
866
"""
867
revno, rev_id = self._get_revision_info(revision)
868
if revno is None:
869
raise bzrlib.errors.NoSuchRevision(self, revision)
870
return revno, rev_id
871
872
394
def get_rev_id(self, revno, history=None):
873
395
"""Find the revision id of the specified revno."""
874
396
if revno == 0:
879
401
raise bzrlib.errors.NoSuchRevision(self, revno)
880
402
return history[revno - 1]
881
403
882
def _get_revision_info(self, revision):
883
"""Return (revno, revision id) for revision specifier.
884
885
revision can be an integer, in which case it is assumed to be revno
886
(though this will translate negative values into positive ones)
887
revision can also be a string, in which case it is parsed for something
888
like 'date:' or 'revid:' etc.
889
890
A revid is always returned. If it is None, the specifier referred to
891
the null revision. If the revid does not occur in the revision
892
history, revno will be None.
893
"""
894
895
if revision is None:
896
return 0, None
897
revno = None
898
try:# Convert to int if possible
899
revision = int(revision)
900
except ValueError:
901
pass
902
revs = self.revision_history()
903
if isinstance(revision, int):
904
if revision < 0:
905
revno = len(revs) + revision + 1
906
else:
907
revno = revision
908
rev_id = self.get_rev_id(revno, revs)
909
elif isinstance(revision, basestring):
910
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
if revision.startswith(prefix):
912
result = func(self, revs, revision)
913
if len(result) > 1:
914
revno, rev_id = result
915
else:
916
revno = result[0]
917
rev_id = self.get_rev_id(revno, revs)
918
break
919
else:
920
raise BzrError('No namespace registered for string: %r' %
921
revision)
922
else:
923
raise TypeError('Unhandled revision type %s' % revision)
924
925
if revno is None:
926
if rev_id is None:
927
raise bzrlib.errors.NoSuchRevision(self, revision)
928
return revno, rev_id
929
930
def _namespace_revno(self, revs, revision):
931
"""Lookup a revision by revision number"""
932
assert revision.startswith('revno:')
933
try:
934
return (int(revision[6:]),)
935
except ValueError:
936
return None
937
REVISION_NAMESPACES['revno:'] = _namespace_revno
938
939
def _namespace_revid(self, revs, revision):
940
assert revision.startswith('revid:')
941
rev_id = revision[len('revid:'):]
942
try:
943
return revs.index(rev_id) + 1, rev_id
944
except ValueError:
945
return None, rev_id
946
REVISION_NAMESPACES['revid:'] = _namespace_revid
947
948
def _namespace_last(self, revs, revision):
949
assert revision.startswith('last:')
950
try:
951
offset = int(revision[5:])
952
except ValueError:
953
return (None,)
954
else:
955
if offset <= 0:
956
raise BzrError('You must supply a positive value for --revision last:XXX')
957
return (len(revs) - offset + 1,)
958
REVISION_NAMESPACES['last:'] = _namespace_last
959
960
def _namespace_tag(self, revs, revision):
961
assert revision.startswith('tag:')
962
raise BzrError('tag: namespace registered, but not implemented.')
963
REVISION_NAMESPACES['tag:'] = _namespace_tag
964
965
def _namespace_date(self, revs, revision):
966
assert revision.startswith('date:')
967
import datetime
968
# Spec for date revisions:
969
# date:value
970
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
# it can also start with a '+/-/='. '+' says match the first
972
# entry after the given date. '-' is match the first entry before the date
973
# '=' is match the first entry after, but still on the given date.
974
#
975
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
# May 13th, 2005 at 0:00
979
#
980
# So the proper way of saying 'give me all entries for today' is:
981
# -r {date:+today}:{date:-tomorrow}
982
# The default is '=' when not supplied
983
val = revision[5:]
984
match_style = '='
985
if val[:1] in ('+', '-', '='):
986
match_style = val[:1]
987
val = val[1:]
988
989
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
if val.lower() == 'yesterday':
991
dt = today - datetime.timedelta(days=1)
992
elif val.lower() == 'today':
993
dt = today
994
elif val.lower() == 'tomorrow':
995
dt = today + datetime.timedelta(days=1)
996
else:
997
import re
998
# This should be done outside the function to avoid recompiling it.
999
_date_re = re.compile(
1000
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1001
r'(,|T)?\s*'
1002
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1003
)
1004
m = _date_re.match(val)
1005
if not m or (not m.group('date') and not m.group('time')):
1006
raise BzrError('Invalid revision date %r' % revision)
1007
1008
if m.group('date'):
1009
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1010
else:
1011
year, month, day = today.year, today.month, today.day
1012
if m.group('time'):
1013
hour = int(m.group('hour'))
1014
minute = int(m.group('minute'))
1015
if m.group('second'):
1016
second = int(m.group('second'))
1017
else:
1018
second = 0
1019
else:
1020
hour, minute, second = 0,0,0
1021
1022
dt = datetime.datetime(year=year, month=month, day=day,
1023
hour=hour, minute=minute, second=second)
1024
first = dt
1025
last = None
1026
reversed = False
1027
if match_style == '-':
1028
reversed = True
1029
elif match_style == '=':
1030
last = dt + datetime.timedelta(days=1)
1031
1032
if reversed:
1033
for i in range(len(revs)-1, -1, -1):
1034
r = self.get_revision(revs[i])
1035
# TODO: Handle timezone.
1036
dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
if first >= dt and (last is None or dt >= last):
1038
return (i+1,)
1039
else:
1040
for i in range(len(revs)):
1041
r = self.get_revision(revs[i])
1042
# TODO: Handle timezone.
1043
dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
if first <= dt and (last is None or dt <= last):
1045
return (i+1,)
1046
REVISION_NAMESPACES['date:'] = _namespace_date
1047
1048
404
def revision_tree(self, revision_id):
1049
405
"""Return Tree for a revision on this branch.
1050
406
1051
407
`revision_id` may be None for the null revision, in which case
1052
408
an `EmptyTree` is returned."""
1053
# TODO: refactor this to use an existing revision object
1054
# so we don't need to read it in twice.
1055
if revision_id == None:
1056
return EmptyTree()
1057
else:
1058
inv = self.get_revision_inventory(revision_id)
1059
return RevisionTree(self.weave_store, inv, revision_id)
1060
409
raise NotImplementedError('revision_tree is abstract')
1061
410
1062
411
def working_tree(self):
1063
"""Return a `Tree` for the working copy."""
1064
from workingtree import WorkingTree
1065
return WorkingTree(self.base, self.read_working_inventory())
412
"""Return a `Tree` for the working copy if this is a local branch."""
413
raise NotImplementedError('working_tree is abstract')
1066
414
415
def pull(self, source, overwrite=False):
416
raise NotImplementedError('pull is abstract')
1067
417
1068
418
def basis_tree(self):
1069
419
"""Return `Tree` object for last revision.
1070
420
1071
421
If there are no revisions yet, return an `EmptyTree`.
1072
422
"""
1073
return self.revision_tree(self.last_patch())
1074
423
return self.revision_tree(self.last_revision())
1075
424
1076
425
def rename_one(self, from_rel, to_rel):
1077
426
"""Rename one file.
1078
427
1079
428
This can change the directory or the filename or both.
1080
429
"""
1081
self.lock_write()
1082
try:
1083
tree = self.working_tree()
1084
inv = tree.inventory
1085
if not tree.has_filename(from_rel):
1086
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1087
if tree.has_filename(to_rel):
1088
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1089
1090
file_id = inv.path2id(from_rel)
1091
if file_id == None:
1092
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1093
1094
if inv.path2id(to_rel):
1095
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1096
1097
to_dir, to_tail = os.path.split(to_rel)
1098
to_dir_id = inv.path2id(to_dir)
1099
if to_dir_id == None and to_dir != '':
1100
raise BzrError("can't determine destination directory id for %r" % to_dir)
1101
1102
mutter("rename_one:")
1103
mutter(" file_id {%s}" % file_id)
1104
mutter(" from_rel %r" % from_rel)
1105
mutter(" to_rel %r" % to_rel)
1106
mutter(" to_dir %r" % to_dir)
1107
mutter(" to_dir_id {%s}" % to_dir_id)
1108
1109
inv.rename(file_id, to_dir_id, to_tail)
1110
1111
from_abs = self.abspath(from_rel)
1112
to_abs = self.abspath(to_rel)
1113
try:
1114
os.rename(from_abs, to_abs)
1115
except OSError, e:
1116
raise BzrError("failed to rename %r to %r: %s"
1117
% (from_abs, to_abs, e[1]),
1118
["rename rolled back"])
1119
1120
self._write_inventory(inv)
1121
finally:
1122
self.unlock()
1123
430
raise NotImplementedError('rename_one is abstract')
1124
431
1125
432
def move(self, from_paths, to_name):
1126
433
"""Rename files.
1136
443
This returns a list of (from_path, to_path) pairs for each
1137
444
entry that is moved.
1138
445
"""
1139
result = []
1140
self.lock_write()
1141
try:
1142
## TODO: Option to move IDs only
1143
assert not isinstance(from_paths, basestring)
1144
tree = self.working_tree()
1145
inv = tree.inventory
1146
to_abs = self.abspath(to_name)
1147
if not isdir(to_abs):
1148
raise BzrError("destination %r is not a directory" % to_abs)
1149
if not tree.has_filename(to_name):
1150
raise BzrError("destination %r not in working directory" % to_abs)
1151
to_dir_id = inv.path2id(to_name)
1152
if to_dir_id == None and to_name != '':
1153
raise BzrError("destination %r is not a versioned directory" % to_name)
1154
to_dir_ie = inv[to_dir_id]
1155
if to_dir_ie.kind not in ('directory', 'root_directory'):
1156
raise BzrError("destination %r is not a directory" % to_abs)
1157
1158
to_idpath = inv.get_idpath(to_dir_id)
1159
1160
for f in from_paths:
1161
if not tree.has_filename(f):
1162
raise BzrError("%r does not exist in working tree" % f)
1163
f_id = inv.path2id(f)
1164
if f_id == None:
1165
raise BzrError("%r is not versioned" % f)
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
if tree.has_filename(dest_path):
1169
raise BzrError("destination %r already exists" % dest_path)
1170
if f_id in to_idpath:
1171
raise BzrError("can't move %r to a subdirectory of itself" % f)
1172
1173
# OK, so there's a race here, it's possible that someone will
1174
# create a file in this interval and then the rename might be
1175
# left half-done. But we should have caught most problems.
1176
1177
for f in from_paths:
1178
name_tail = splitpath(f)[-1]
1179
dest_path = appendpath(to_name, name_tail)
1180
result.append((f, dest_path))
1181
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1182
try:
1183
os.rename(self.abspath(f), self.abspath(dest_path))
1184
except OSError, e:
1185
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1186
["rename rolled back"])
1187
1188
self._write_inventory(inv)
1189
finally:
1190
self.unlock()
1191
1192
return result
1193
1194
1195
def revert(self, filenames, old_tree=None, backups=True):
1196
"""Restore selected files to the versions from a previous tree.
1197
1198
backups
1199
If true (default) backups are made of files before
1200
they're renamed.
1201
"""
1202
from bzrlib.errors import NotVersionedError, BzrError
1203
from bzrlib.atomicfile import AtomicFile
1204
from bzrlib.osutils import backup_file
1205
1206
inv = self.read_working_inventory()
1207
if old_tree is None:
1208
old_tree = self.basis_tree()
1209
old_inv = old_tree.inventory
1210
1211
nids = []
1212
for fn in filenames:
1213
file_id = inv.path2id(fn)
1214
if not file_id:
1215
raise NotVersionedError("not a versioned file", fn)
1216
if not old_inv.has_id(file_id):
1217
raise BzrError("file not present in old tree", fn, file_id)
1218
nids.append((fn, file_id))
1219
1220
# TODO: Rename back if it was previously at a different location
1221
1222
# TODO: If given a directory, restore the entire contents from
1223
# the previous version.
1224
1225
# TODO: Make a backup to a temporary file.
1226
1227
# TODO: If the file previously didn't exist, delete it?
1228
for fn, file_id in nids:
1229
backup_file(fn)
1230
1231
f = AtomicFile(fn, 'wb')
1232
try:
1233
f.write(old_tree.get_file(file_id).read())
1234
f.commit()
1235
finally:
1236
f.close()
1237
1238
1239
def pending_merges(self):
1240
"""Return a list of pending merges.
1241
1242
These are revisions that have been merged into the working
1243
directory but not yet committed.
1244
"""
1245
cfn = self.controlfilename('pending-merges')
1246
if not os.path.exists(cfn):
1247
return []
1248
p = []
1249
for l in self.controlfile('pending-merges', 'r').readlines():
1250
p.append(l.rstrip('\n'))
1251
return p
1252
1253
1254
def add_pending_merge(self, revision_id):
1255
from bzrlib.revision import validate_revision_id
1256
1257
validate_revision_id(revision_id)
1258
1259
p = self.pending_merges()
1260
if revision_id in p:
1261
return
1262
p.append(revision_id)
1263
self.set_pending_merges(p)
1264
1265
1266
def set_pending_merges(self, rev_list):
1267
from bzrlib.atomicfile import AtomicFile
1268
self.lock_write()
1269
try:
1270
f = AtomicFile(self.controlfilename('pending-merges'))
1271
try:
1272
for l in rev_list:
1273
print >>f, l
1274
f.commit()
1275
finally:
1276
f.close()
1277
finally:
1278
self.unlock()
1279
446
raise NotImplementedError('move is abstract')
1280
447
1281
448
def get_parent(self):
1282
449
"""Return the parent location of the branch.
1285
452
pattern is that the user can override it by specifying a
1286
453
location.
1287
454
"""
1288
import errno
1289
_locs = ['parent', 'pull', 'x-pull']
1290
for l in _locs:
1291
try:
1292
return self.controlfile(l, 'r').read().strip('\n')
1293
except IOError, e:
1294
if e.errno != errno.ENOENT:
1295
raise
1296
return None
1297
455
raise NotImplementedError('get_parent is abstract')
456
457
def get_push_location(self):
458
"""Return the None or the location to push this branch to."""
459
raise NotImplementedError('get_push_location is abstract')
460
461
def set_push_location(self, location):
462
"""Set a new push location for this branch."""
463
raise NotImplementedError('set_push_location is abstract')
1298
464
1299
465
def set_parent(self, url):
1300
# TODO: Maybe delete old location files?
1301
from bzrlib.atomicfile import AtomicFile
1302
self.lock_write()
1303
try:
1304
f = AtomicFile(self.controlfilename('parent'))
1305
try:
1306
f.write(url + '\n')
1307
f.commit()
1308
finally:
1309
f.close()
1310
finally:
1311
self.unlock()
466
raise NotImplementedError('set_parent is abstract')
1312
467
1313
468
def check_revno(self, revno):
1314
469
"""\
1326
481
if revno < 1 or revno > self.revno():
1327
482
raise InvalidRevisionNumber(revno)
1328
483
1329
1330
1331
1332
class ScratchBranch(Branch):
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
486
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
489
490
class BzrBranch(Branch):
491
"""A branch stored in the actual filesystem.
492
493
Note that it's "local" in the context of the filesystem; it doesn't
494
really matter if it's on an nfs/smb/afs/coda/... share, as long as
495
it's writable, and can be accessed via the normal filesystem API.
496
497
_lock_mode
498
None, or 'r' or 'w'
499
500
_lock_count
501
If _lock_mode is true, a positive count of the number of times the
502
lock has been taken.
503
504
_lock
505
Lock object from bzrlib.lock.
506
"""
507
# We actually expect this class to be somewhat short-lived; part of its
508
# purpose is to try to isolate what bits of the branch logic are tied to
509
# filesystem access, so that in a later step, we can extricate them to
510
# a separarte ("storage") class.
511
_lock_mode = None
512
_lock_count = None
513
_lock = None
514
_inventory_weave = None
515
# If set to False (by a plugin, etc) BzrBranch will not set the
516
# mode on created files or directories
517
_set_file_mode = True
518
_set_dir_mode = True
519
520
# Map some sort of prefix into a namespace
521
# stuff like "revno:10", "revid:", etc.
522
# This should match a prefix with a function which accepts
523
REVISION_NAMESPACES = {}
524
525
def push_stores(self, branch_to):
526
"""See Branch.push_stores."""
527
if (self._branch_format != branch_to._branch_format
528
or self._branch_format != 4):
529
from bzrlib.fetch import greedy_fetch
530
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
531
self, self._branch_format, branch_to, branch_to._branch_format)
532
greedy_fetch(to_branch=branch_to, from_branch=self,
533
revision=self.last_revision())
534
return
535
536
store_pairs = ((self.text_store, branch_to.text_store),
537
(self.inventory_store, branch_to.inventory_store),
538
(self.revision_store, branch_to.revision_store))
539
try:
540
for from_store, to_store in store_pairs:
541
copy_all(from_store, to_store)
542
except UnlistableStore:
543
raise UnlistableBranch(from_store)
544
545
def __init__(self, transport, init=False,
546
relax_version_check=False):
547
"""Create new branch object at a particular location.
548
549
transport -- A Transport object, defining how to access files.
550
551
init -- If True, create new control files in a previously
552
unversioned directory. If False, the branch must already
553
be versioned.
554
555
relax_version_check -- If true, the usual check for the branch
556
version is not applied. This is intended only for
557
upgrade/recovery type use; it's not guaranteed that
558
all operations will work on old format branches.
559
560
In the test suite, creation of new trees is tested using the
561
`ScratchBranch` class.
562
"""
563
assert isinstance(transport, Transport), \
564
"%r is not a Transport" % transport
565
self._transport = transport
566
if init:
567
self._make_control()
568
self._check_format(relax_version_check)
569
self._find_modes()
570
571
def get_store(name, compressed=True, prefixed=False):
572
relpath = self._rel_controlfilename(unicode(name))
573
store = TextStore(self._transport.clone(relpath),
574
dir_mode=self._dir_mode,
575
file_mode=self._file_mode,
576
prefixed=prefixed,
577
compressed=compressed)
578
return store
579
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(unicode(name))
582
ws = WeaveStore(self._transport.clone(relpath),
583
prefixed=prefixed,
584
dir_mode=self._dir_mode,
585
file_mode=self._file_mode)
586
if self._transport.should_cache():
587
ws.enable_cache = True
588
return ws
589
590
if self._branch_format == 4:
591
self.inventory_store = get_store('inventory-store')
592
self.text_store = get_store('text-store')
593
self.revision_store = get_store('revision-store')
594
elif self._branch_format == 5:
595
self.control_weaves = get_weave(u'')
596
self.weave_store = get_weave(u'weaves')
597
self.revision_store = get_store(u'revision-store', compressed=False)
598
elif self._branch_format == 6:
599
self.control_weaves = get_weave(u'')
600
self.weave_store = get_weave(u'weaves', prefixed=True)
601
self.revision_store = get_store(u'revision-store', compressed=False,
602
prefixed=True)
603
self.revision_store.register_suffix('sig')
604
self._transaction = None
605
606
def __str__(self):
607
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
608
609
__repr__ = __str__
610
611
def __del__(self):
612
if self._lock_mode or self._lock:
613
# XXX: This should show something every time, and be suitable for
614
# headless operation and embedding
615
warn("branch %r was not explicitly unlocked" % self)
616
self._lock.unlock()
617
618
# TODO: It might be best to do this somewhere else,
619
# but it is nice for a Branch object to automatically
620
# cache it's information.
621
# Alternatively, we could have the Transport objects cache requests
622
# See the earlier discussion about how major objects (like Branch)
623
# should never expect their __del__ function to run.
624
if hasattr(self, 'cache_root') and self.cache_root is not None:
625
try:
626
shutil.rmtree(self.cache_root)
627
except:
628
pass
629
self.cache_root = None
630
631
def _get_base(self):
632
if self._transport:
633
return self._transport.base
634
return None
635
636
base = property(_get_base, doc="The URL for the root of this branch.")
637
638
def _finish_transaction(self):
639
"""Exit the current transaction."""
640
if self._transaction is None:
641
raise errors.LockError('Branch %s is not in a transaction' %
642
self)
643
transaction = self._transaction
644
self._transaction = None
645
transaction.finish()
646
647
def get_transaction(self):
648
"""See Branch.get_transaction."""
649
if self._transaction is None:
650
return transactions.PassThroughTransaction()
651
else:
652
return self._transaction
653
654
def _set_transaction(self, new_transaction):
655
"""Set a new active transaction."""
656
if self._transaction is not None:
657
raise errors.LockError('Branch %s is in a transaction already.' %
658
self)
659
self._transaction = new_transaction
660
661
def lock_write(self):
662
#mutter("lock write: %s (%s)", self, self._lock_count)
663
# TODO: Upgrade locking to support using a Transport,
664
# and potentially a remote locking protocol
665
if self._lock_mode:
666
if self._lock_mode != 'w':
667
raise LockError("can't upgrade to a write lock from %r" %
668
self._lock_mode)
669
self._lock_count += 1
670
else:
671
self._lock = self._transport.lock_write(
672
self._rel_controlfilename('branch-lock'))
673
self._lock_mode = 'w'
674
self._lock_count = 1
675
self._set_transaction(transactions.PassThroughTransaction())
676
677
def lock_read(self):
678
#mutter("lock read: %s (%s)", self, self._lock_count)
679
if self._lock_mode:
680
assert self._lock_mode in ('r', 'w'), \
681
"invalid lock mode %r" % self._lock_mode
682
self._lock_count += 1
683
else:
684
self._lock = self._transport.lock_read(
685
self._rel_controlfilename('branch-lock'))
686
self._lock_mode = 'r'
687
self._lock_count = 1
688
self._set_transaction(transactions.ReadOnlyTransaction())
689
# 5K may be excessive, but hey, its a knob.
690
self.get_transaction().set_cache_size(5000)
691
692
def unlock(self):
693
#mutter("unlock: %s (%s)", self, self._lock_count)
694
if not self._lock_mode:
695
raise LockError('branch %r is not locked' % (self))
696
697
if self._lock_count > 1:
698
self._lock_count -= 1
699
else:
700
self._finish_transaction()
701
self._lock.unlock()
702
self._lock = None
703
self._lock_mode = self._lock_count = None
704
705
def abspath(self, name):
706
"""See Branch.abspath."""
707
return self._transport.abspath(name)
708
709
def _rel_controlfilename(self, file_or_path):
710
if not isinstance(file_or_path, basestring):
711
file_or_path = u'/'.join(file_or_path)
712
if file_or_path == '':
713
return bzrlib.BZRDIR
714
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
715
716
def controlfilename(self, file_or_path):
717
"""See Branch.controlfilename."""
718
return self._transport.abspath(self._rel_controlfilename(file_or_path))
719
720
def controlfile(self, file_or_path, mode='r'):
721
"""See Branch.controlfile."""
722
import codecs
723
724
relpath = self._rel_controlfilename(file_or_path)
725
#TODO: codecs.open() buffers linewise, so it was overloaded with
726
# a much larger buffer, do we need to do the same for getreader/getwriter?
727
if mode == 'rb':
728
return self._transport.get(relpath)
729
elif mode == 'wb':
730
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
731
elif mode == 'r':
732
# XXX: Do we really want errors='replace'? Perhaps it should be
733
# an error, or at least reported, if there's incorrectly-encoded
734
# data inside a file.
735
# <https://launchpad.net/products/bzr/+bug/3823>
736
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
737
elif mode == 'w':
738
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
739
else:
740
raise BzrError("invalid controlfile mode %r" % mode)
741
742
def put_controlfile(self, path, f, encode=True):
743
"""See Branch.put_controlfile."""
744
self.put_controlfiles([(path, f)], encode=encode)
745
746
def put_controlfiles(self, files, encode=True):
747
"""See Branch.put_controlfiles."""
748
import codecs
749
ctrl_files = []
750
for path, f in files:
751
if encode:
752
if isinstance(f, basestring):
753
f = f.encode('utf-8', 'replace')
754
else:
755
f = codecs.getwriter('utf-8')(f, errors='replace')
756
path = self._rel_controlfilename(path)
757
ctrl_files.append((path, f))
758
self._transport.put_multi(ctrl_files, mode=self._file_mode)
759
760
def _find_modes(self, path=None):
761
"""Determine the appropriate modes for files and directories."""
762
try:
763
if path is None:
764
path = self._rel_controlfilename('')
765
st = self._transport.stat(path)
766
except errors.TransportNotPossible:
767
self._dir_mode = 0755
768
self._file_mode = 0644
769
else:
770
self._dir_mode = st.st_mode & 07777
771
# Remove the sticky and execute bits for files
772
self._file_mode = self._dir_mode & ~07111
773
if not self._set_dir_mode:
774
self._dir_mode = None
775
if not self._set_file_mode:
776
self._file_mode = None
777
778
def _make_control(self):
779
from bzrlib.inventory import Inventory
780
from bzrlib.weavefile import write_weave_v5
781
from bzrlib.weave import Weave
782
783
# Create an empty inventory
784
sio = StringIO()
785
# if we want per-tree root ids then this is the place to set
786
# them; they're not needed for now and so ommitted for
787
# simplicity.
788
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
789
empty_inv = sio.getvalue()
790
sio = StringIO()
791
bzrlib.weavefile.write_weave_v5(Weave(), sio)
792
empty_weave = sio.getvalue()
793
794
cfn = self._rel_controlfilename
795
# Since we don't have a .bzr directory, inherit the
796
# mode from the root directory
797
self._find_modes(u'.')
798
799
dirs = ['', 'revision-store', 'weaves']
800
files = [('README',
801
"This is a Bazaar-NG control directory.\n"
802
"Do not change any files in this directory.\n"),
803
('branch-format', BZR_BRANCH_FORMAT_6),
804
('revision-history', ''),
805
('branch-name', ''),
806
('branch-lock', ''),
807
('pending-merges', ''),
808
('inventory', empty_inv),
809
('inventory.weave', empty_weave),
810
('ancestry.weave', empty_weave)
811
]
812
self._transport.mkdir_multi([cfn(d) for d in dirs], mode=self._dir_mode)
813
self.put_controlfiles(files)
814
mutter('created control directory in ' + self._transport.base)
815
816
def _check_format(self, relax_version_check):
817
"""Check this branch format is supported.
818
819
The format level is stored, as an integer, in
820
self._branch_format for code that needs to check it later.
821
822
In the future, we might need different in-memory Branch
823
classes to support downlevel branches. But not yet.
824
"""
825
try:
826
fmt = self.controlfile('branch-format', 'r').read()
827
except NoSuchFile:
828
raise NotBranchError(path=self.base)
829
mutter("got branch format %r", fmt)
830
if fmt == BZR_BRANCH_FORMAT_6:
831
self._branch_format = 6
832
elif fmt == BZR_BRANCH_FORMAT_5:
833
self._branch_format = 5
834
elif fmt == BZR_BRANCH_FORMAT_4:
835
self._branch_format = 4
836
837
if (not relax_version_check
838
and self._branch_format not in (5, 6)):
839
raise errors.UnsupportedFormatError(
840
'sorry, branch format %r not supported' % fmt,
841
['use a different bzr version',
842
'or remove the .bzr directory'
843
' and "bzr init" again'])
844
845
@needs_read_lock
846
def get_root_id(self):
847
"""See Branch.get_root_id."""
848
inv = self.get_inventory(self.last_revision())
849
return inv.root.file_id
850
851
@needs_read_lock
852
def print_file(self, file, revision_id):
853
"""See Branch.print_file."""
854
tree = self.revision_tree(revision_id)
855
# use inventory as it was in that revision
856
file_id = tree.inventory.path2id(file)
857
if not file_id:
858
try:
859
revno = self.revision_id_to_revno(revision_id)
860
except errors.NoSuchRevision:
861
# TODO: This should not be BzrError,
862
# but NoSuchFile doesn't fit either
863
raise BzrError('%r is not present in revision %s'
864
% (file, revision_id))
865
else:
866
raise BzrError('%r is not present in revision %s'
867
% (file, revno))
868
tree.print_file(file_id)
869
870
@needs_write_lock
871
def append_revision(self, *revision_ids):
872
"""See Branch.append_revision."""
873
for revision_id in revision_ids:
874
mutter("add {%s} to revision-history" % revision_id)
875
rev_history = self.revision_history()
876
rev_history.extend(revision_ids)
877
self.set_revision_history(rev_history)
878
879
@needs_write_lock
880
def set_revision_history(self, rev_history):
881
"""See Branch.set_revision_history."""
882
old_revision = self.last_revision()
883
new_revision = rev_history[-1]
884
self.put_controlfile('revision-history', '\n'.join(rev_history))
885
try:
886
self.working_tree().set_last_revision(new_revision, old_revision)
887
except NoWorkingTree:
888
mutter('Unable to set_last_revision without a working tree.')
889
890
def has_revision(self, revision_id):
891
"""See Branch.has_revision."""
892
return (revision_id is None
893
or self.revision_store.has_id(revision_id))
894
895
@needs_read_lock
896
def _get_revision_xml_file(self, revision_id):
897
if not revision_id or not isinstance(revision_id, basestring):
898
raise InvalidRevisionId(revision_id=revision_id, branch=self)
899
try:
900
return self.revision_store.get(revision_id)
901
except (IndexError, KeyError):
902
raise bzrlib.errors.NoSuchRevision(self, revision_id)
903
904
def get_revision_xml(self, revision_id):
905
"""See Branch.get_revision_xml."""
906
return self._get_revision_xml_file(revision_id).read()
907
908
def get_revision(self, revision_id):
909
"""See Branch.get_revision."""
910
xml_file = self._get_revision_xml_file(revision_id)
911
912
try:
913
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
914
except SyntaxError, e:
915
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
916
[revision_id,
917
str(e)])
918
919
assert r.revision_id == revision_id
920
return r
921
922
def get_revision_sha1(self, revision_id):
923
"""See Branch.get_revision_sha1."""
924
# In the future, revision entries will be signed. At that
925
# point, it is probably best *not* to include the signature
926
# in the revision hash. Because that lets you re-sign
927
# the revision, (add signatures/remove signatures) and still
928
# have all hash pointers stay consistent.
929
# But for now, just hash the contents.
930
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
931
932
def get_ancestry(self, revision_id):
933
"""See Branch.get_ancestry."""
934
if revision_id is None:
935
return [None]
936
w = self._get_inventory_weave()
937
return [None] + map(w.idx_to_name,
938
w.inclusions([w.lookup(revision_id)]))
939
940
def _get_inventory_weave(self):
941
return self.control_weaves.get_weave('inventory',
942
self.get_transaction())
943
944
def get_inventory(self, revision_id):
945
"""See Branch.get_inventory."""
946
xml = self.get_inventory_xml(revision_id)
947
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
948
949
def get_inventory_xml(self, revision_id):
950
"""See Branch.get_inventory_xml."""
951
try:
952
assert isinstance(revision_id, basestring), type(revision_id)
953
iw = self._get_inventory_weave()
954
return iw.get_text(iw.lookup(revision_id))
955
except IndexError:
956
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
957
958
def get_inventory_sha1(self, revision_id):
959
"""See Branch.get_inventory_sha1."""
960
return self.get_revision(revision_id).inventory_sha1
961
962
def get_revision_inventory(self, revision_id):
963
"""See Branch.get_revision_inventory."""
964
# TODO: Unify this with get_inventory()
965
# bzr 0.0.6 and later imposes the constraint that the inventory_id
966
# must be the same as its revision, so this is trivial.
967
if revision_id == None:
968
# This does not make sense: if there is no revision,
969
# then it is the current tree inventory surely ?!
970
# and thus get_root_id() is something that looks at the last
971
# commit on the branch, and the get_root_id is an inventory check.
972
raise NotImplementedError
973
# return Inventory(self.get_root_id())
974
else:
975
return self.get_inventory(revision_id)
976
977
@needs_read_lock
978
def revision_history(self):
979
"""See Branch.revision_history."""
980
transaction = self.get_transaction()
981
history = transaction.map.find_revision_history()
982
if history is not None:
983
mutter("cache hit for revision-history in %s", self)
984
return list(history)
985
history = [l.rstrip('\r\n') for l in
986
self.controlfile('revision-history', 'r').readlines()]
987
transaction.map.add_revision_history(history)
988
# this call is disabled because revision_history is
989
# not really an object yet, and the transaction is for objects.
990
# transaction.register_clean(history, precious=True)
991
return list(history)
992
993
def update_revisions(self, other, stop_revision=None):
994
"""See Branch.update_revisions."""
995
from bzrlib.fetch import greedy_fetch
996
if stop_revision is None:
997
stop_revision = other.last_revision()
998
### Should this be checking is_ancestor instead of revision_history?
999
if (stop_revision is not None and
1000
stop_revision in self.revision_history()):
1001
return
1002
greedy_fetch(to_branch=self, from_branch=other,
1003
revision=stop_revision)
1004
pullable_revs = self.pullable_revisions(other, stop_revision)
1005
if len(pullable_revs) > 0:
1006
self.append_revision(*pullable_revs)
1007
1008
def pullable_revisions(self, other, stop_revision):
1009
"""See Branch.pullable_revisions."""
1010
other_revno = other.revision_id_to_revno(stop_revision)
1011
try:
1012
return self.missing_revisions(other, other_revno)
1013
except DivergedBranches, e:
1014
try:
1015
pullable_revs = get_intervening_revisions(self.last_revision(),
1016
stop_revision, self)
1017
assert self.last_revision() not in pullable_revs
1018
return pullable_revs
1019
except bzrlib.errors.NotAncestor:
1020
if is_ancestor(self.last_revision(), stop_revision, self):
1021
return []
1022
else:
1023
raise e
1024
1025
def revision_tree(self, revision_id):
1026
"""See Branch.revision_tree."""
1027
# TODO: refactor this to use an existing revision object
1028
# so we don't need to read it in twice.
1029
if revision_id == None or revision_id == NULL_REVISION:
1030
return EmptyTree()
1031
else:
1032
inv = self.get_revision_inventory(revision_id)
1033
return RevisionTree(self, inv, revision_id)
1034
1035
def basis_tree(self):
1036
"""See Branch.basis_tree."""
1037
try:
1038
revision_id = self.revision_history()[-1]
1039
xml = self.working_tree().read_basis_inventory(revision_id)
1040
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1041
return RevisionTree(self, inv, revision_id)
1042
except (IndexError, NoSuchFile, NoWorkingTree), e:
1043
return self.revision_tree(self.last_revision())
1044
1045
def working_tree(self):
1046
"""See Branch.working_tree."""
1047
from bzrlib.workingtree import WorkingTree
1048
if self._transport.base.find('://') != -1:
1049
raise NoWorkingTree(self.base)
1050
return WorkingTree(self.base, branch=self)
1051
1052
@needs_write_lock
1053
def pull(self, source, overwrite=False):
1054
"""See Branch.pull."""
1055
source.lock_read()
1056
try:
1057
old_count = len(self.revision_history())
1058
try:
1059
self.update_revisions(source)
1060
except DivergedBranches:
1061
if not overwrite:
1062
raise
1063
if overwrite:
1064
self.set_revision_history(source.revision_history())
1065
new_count = len(self.revision_history())
1066
return new_count - old_count
1067
finally:
1068
source.unlock()
1069
1070
def get_parent(self):
1071
"""See Branch.get_parent."""
1072
import errno
1073
_locs = ['parent', 'pull', 'x-pull']
1074
for l in _locs:
1075
try:
1076
return self.controlfile(l, 'r').read().strip('\n')
1077
except NoSuchFile:
1078
pass
1079
return None
1080
1081
def get_push_location(self):
1082
"""See Branch.get_push_location."""
1083
config = bzrlib.config.BranchConfig(self)
1084
push_loc = config.get_user_option('push_location')
1085
return push_loc
1086
1087
def set_push_location(self, location):
1088
"""See Branch.set_push_location."""
1089
config = bzrlib.config.LocationConfig(self.base)
1090
config.set_user_option('push_location', location)
1091
1092
@needs_write_lock
1093
def set_parent(self, url):
1094
"""See Branch.set_parent."""
1095
# TODO: Maybe delete old location files?
1096
from bzrlib.atomicfile import AtomicFile
1097
f = AtomicFile(self.controlfilename('parent'))
1098
try:
1099
f.write(url + '\n')
1100
f.commit()
1101
finally:
1102
f.close()
1103
1104
def tree_config(self):
1105
return TreeConfig(self)
1106
1107
def sign_revision(self, revision_id, gpg_strategy):
1108
"""See Branch.sign_revision."""
1109
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1110
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1111
1112
@needs_write_lock
1113
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1114
"""See Branch.store_revision_signature."""
1115
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1116
revision_id, "sig")
1117
1118
1119
class ScratchBranch(BzrBranch):
1333
1120
"""Special test class: a branch that cleans up after itself.
1334
1121
1335
1122
>>> b = ScratchBranch()
1336
1123
>>> isdir(b.base)
1337
1124
True
1338
1125
>>> bd = b.base
1339
>>> b.destroy()
1126
>>> b._transport.__del__()
1340
1127
>>> isdir(bd)
1341
1128
False
1342
1129
"""
1343
def __init__(self, files=[], dirs=[], base=None):
1130
1131
def __init__(self, files=[], dirs=[], transport=None):
1344
1132
"""Make a test branch.
1345
1133
1346
1134
This creates a temporary directory and runs init-tree in it.
1347
1135
1348
1136
If any files are listed, they are created in the working copy.
1349
1137
"""
1350
from tempfile import mkdtemp
1351
init = False
1352
if base is None:
1353
base = mkdtemp()
1354
init = True
1355
Branch.__init__(self, base, init=init)
1138
if transport is None:
1139
transport = bzrlib.transport.local.ScratchTransport()
1140
super(ScratchBranch, self).__init__(transport, init=True)
1141
else:
1142
super(ScratchBranch, self).__init__(transport)
1143
1356
1144
for d in dirs:
1357
os.mkdir(self.abspath(d))
1145
self._transport.mkdir(d)
1358
1146
1359
1147
for f in files:
1360
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1148
self._transport.put(f, 'content of %s' % f)
1361
1149
1362
1150
1363
1151
def clone(self):
1364
1152
"""
1365
1153
>>> orig = ScratchBranch(files=["file1", "file2"])
1366
1154
>>> clone = orig.clone()
1367
>>> os.path.samefile(orig.base, clone.base)
1155
>>> if os.name != 'nt':
1156
... os.path.samefile(orig.base, clone.base)
1157
... else:
1158
... orig.base == clone.base
1159
...
1368
1160
False
1369
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1161
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1370
1162
True
1371
1163
"""
1372
1164
from shutil import copytree
1373
from tempfile import mkdtemp
1165
from bzrlib.osutils import mkdtemp
1374
1166
base = mkdtemp()
1375
1167
os.rmdir(base)
1376
1168
copytree(self.base, base, symlinks=True)
1377
return ScratchBranch(base=base)
1378
1379
1380
1381
def __del__(self):
1382
self.destroy()
1383
1384
def destroy(self):
1385
"""Destroy the test branch, removing the scratch directory."""
1386
from shutil import rmtree
1387
try:
1388
if self.base:
1389
mutter("delete ScratchBranch %s" % self.base)
1390
rmtree(self.base)
1391
except OSError, e:
1392
# Work around for shutil.rmtree failing on Windows when
1393
# readonly files are encountered
1394
mutter("hit exception in destroying ScratchBranch: %s" % e)
1395
for root, dirs, files in os.walk(self.base, topdown=False):
1396
for name in files:
1397
os.chmod(os.path.join(root, name), 0700)
1398
rmtree(self.base)
1399
self.base = None
1400
1169
return ScratchBranch(
1170
transport=bzrlib.transport.local.ScratchTransport(base))
1401
1171
1402
1172
1403
1173
######################################################################
1406
1176
1407
1177
def is_control_file(filename):
1408
1178
## FIXME: better check
1409
filename = os.path.normpath(filename)
1179
filename = normpath(filename)
1410
1180
while filename != '':
1411
1181
head, tail = os.path.split(filename)
1412
1182
## mutter('check %r for control file' % ((head, tail), ))
1416
1186
break
1417
1187
filename = head
1418
1188
return False
1419
1420
1421
1422
def gen_file_id(name):
1423
"""Return new file id.
1424
1425
This should probably generate proper UUIDs, but for the moment we
1426
cope with just randomness because running uuidgen every time is
1427
slow."""
1428
import re
1429
from binascii import hexlify
1430
from time import time
1431
1432
# get last component
1433
idx = name.rfind('/')
1434
if idx != -1:
1435
name = name[idx+1 : ]
1436
idx = name.rfind('\\')
1437
if idx != -1:
1438
name = name[idx+1 : ]
1439
1440
# make it not a hidden file
1441
name = name.lstrip('.')
1442
1443
# remove any wierd characters; we don't escape them but rather
1444
# just pull them out
1445
name = re.sub(r'[^\w.]', '', name)
1446
1447
s = hexlify(rand_bytes(8))
1448
return '-'.join((name, compact_date(time()), s))
1449
1450
1451
def gen_root_id():
1452
"""Return a new tree-root file id."""
1453
return gen_file_id('TREE_ROOT')
1454
1455
1456
def pull_loc(branch):
1457
# TODO: Should perhaps just make attribute be 'base' in
1458
# RemoteBranch and Branch?
1459
if hasattr(branch, "baseurl"):
1460
return branch.baseurl
1461
else:
1462
return branch.base
1463
1464
1465
def copy_branch(branch_from, to_location, revision=None):
1466
"""Copy branch_from into the existing directory to_location.
1467
1468
revision
1469
If not None, only revisions up to this point will be copied.
1470
The head of the new branch will be that revision.
1471
1472
to_location
1473
The name of a local directory that exists but is empty.
1474
"""
1475
from bzrlib.merge import merge
1476
from bzrlib.branch import Branch
1477
1478
assert isinstance(branch_from, Branch)
1479
assert isinstance(to_location, basestring)
1480
1481
br_to = Branch(to_location, init=True)
1482
br_to.set_root_id(branch_from.get_root_id())
1483
if revision is None:
1484
revno = branch_from.revno()
1485
else:
1486
revno, rev_id = branch_from.get_revision_info(revision)
1487
br_to.update_revisions(branch_from, stop_revision=revno)
1488
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
check_clean=False, ignore_zero=True)
1490
1491
from_location = pull_loc(branch_from)
1492
br_to.set_parent(pull_loc(branch_from))
1493
Loggerhead is a web-based interface for Breezy
Version: 2.0.1