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