« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 520
- compare with another revision
- download diff
- download tarball
- view history from revision 520
- Committer: Martin Pool
- Date: 2005-05-17 06:56:16 UTC
- Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches
- files added:
- bzrlib/mdiff.py
- files removed:
- HACKING
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- tools
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/store/__init__.py => bzrlib/store.py
- contrib/bash/bzr.simple => contrib/bash/bzr
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/util/urlgrabber/ => urlgrabber/
- 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
19
import sys
20
import os
21
import errno
22
from warnings import warn
23
from cStringIO import StringIO
18
from sets import Set
24
19
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
25
23
26
24
import bzrlib
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
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)
38
from bzrlib.textui import show_status
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
40
NULL_REVISION)
41
42
from bzrlib.delta import compare_trees
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
52
import bzrlib.ui
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"
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
36
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
59
38
## TODO: Maybe include checks for common corruption of newlines, etc?
60
39
61
40
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
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
41
42
def find_branch(f, **args):
43
if f and (f.startswith('http://') or f.startswith('https://')):
44
import remotebranch
45
return remotebranch.RemoteBranch(f, **args)
46
else:
47
return Branch(f, **args)
48
49
50
def find_branch_root(f=None):
51
"""Find the branch root enclosing f, or pwd.
52
53
f may be a filename or a URL.
54
55
It is not necessary that f exists.
56
57
Basically we keep looking up until we find the control directory or
58
run into the root."""
59
if f == None:
60
f = os.getcwd()
61
elif hasattr(os.path, 'realpath'):
62
f = os.path.realpath(f)
63
else:
64
f = os.path.abspath(f)
65
if not os.path.exists(f):
66
raise BzrError('%r does not exist' % f)
67
68
69
orig_f = f
70
71
while True:
72
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
73
return f
74
head, tail = os.path.split(f)
75
if head == f:
76
# reached the root, whatever that may be
77
raise BzrError('%r is not in a branch' % orig_f)
78
f = head
79
80
93
81
94
82
######################################################################
95
83
# branch objects
96
84
97
class Branch(object):
85
class Branch:
98
86
"""Branch holding a history of revisions.
99
87
100
88
base
101
Base directory/url of the branch.
89
Base directory of the branch.
102
90
"""
103
base = None
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.
91
_lockmode = None
92
93
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
94
"""Create new branch object at a particular location.
95
96
base -- Base directory for the branch.
97
98
init -- If True, create new control files in a previously
99
unversioned directory. If False, the branch must already
100
be versioned.
101
102
find_root -- If true and init is false, find the root of the
103
existing branch containing base.
104
105
In the test suite, creation of new trees is tested using the
106
`ScratchBranch` class.
131
107
"""
132
t = get_transport(url)
133
while True:
108
if init:
109
self.base = os.path.realpath(base)
110
self._make_control()
111
elif find_root:
112
self.base = find_branch_root(base)
113
else:
114
self.base = os.path.realpath(base)
115
if not isdir(self.controlfilename('.')):
116
bailout("not a bzr branch: %s" % quotefn(base),
117
['use "bzr init" to initialize a new working tree',
118
'current bzr can only operate from top-of-tree'])
119
self._check_format()
120
self.lock(lock_mode)
121
122
self.text_store = ImmutableStore(self.controlfilename('text-store'))
123
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
124
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
125
126
127
def __str__(self):
128
return '%s(%r)' % (self.__class__.__name__, self.base)
129
130
131
__repr__ = __str__
132
133
134
135
def lock(self, mode='w'):
136
"""Lock the on-disk branch, excluding other processes."""
137
try:
138
import fcntl, errno
139
140
if mode == 'w':
141
lm = fcntl.LOCK_EX
142
om = os.O_WRONLY | os.O_CREAT
143
elif mode == 'r':
144
lm = fcntl.LOCK_SH
145
om = os.O_RDONLY
146
else:
147
raise BzrError("invalid locking mode %r" % mode)
148
134
149
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')
178
179
def lock_write(self):
180
raise NotImplementedError('lock_write is abstract')
181
182
def lock_read(self):
183
raise NotImplementedError('lock_read is abstract')
184
185
def unlock(self):
186
raise NotImplementedError('unlock is abstract')
150
lockfile = os.open(self.controlfilename('branch-lock'), om)
151
except OSError, e:
152
if e.errno == errno.ENOENT:
153
# might not exist on branches from <0.0.4
154
self.controlfile('branch-lock', 'w').close()
155
lockfile = os.open(self.controlfilename('branch-lock'), om)
156
else:
157
raise e
158
159
fcntl.lockf(lockfile, lm)
160
def unlock():
161
fcntl.lockf(lockfile, fcntl.LOCK_UN)
162
os.close(lockfile)
163
self._lockmode = None
164
self.unlock = unlock
165
self._lockmode = mode
166
except ImportError:
167
warning("please write a locking method for platform %r" % sys.platform)
168
def unlock():
169
self._lockmode = None
170
self.unlock = unlock
171
self._lockmode = mode
172
173
174
def _need_readlock(self):
175
if self._lockmode not in ['r', 'w']:
176
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
177
178
def _need_writelock(self):
179
if self._lockmode not in ['w']:
180
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
181
187
182
188
183
def abspath(self, name):
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')
184
"""Return absolute filename for something in the branch"""
185
return os.path.join(self.base, name)
186
187
188
def relpath(self, path):
189
"""Return path relative to this branch of something inside it.
190
191
Raises an error if path is not in this branch."""
192
rp = os.path.realpath(path)
193
# FIXME: windows
194
if not rp.startswith(self.base):
195
bailout("path %r is not within branch %r" % (rp, self.base))
196
rp = rp[len(self.base):]
197
rp = rp.lstrip(os.sep)
198
return rp
199
195
200
196
201
def controlfilename(self, file_or_path):
197
202
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
203
if isinstance(file_or_path, types.StringTypes):
204
file_or_path = [file_or_path]
205
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
206
199
207
200
208
def controlfile(self, file_or_path, mode='r'):
201
209
"""Open a control file for this branch.
208
216
Controlfiles should almost never be opened in write mode but
209
217
rather should be atomically copied and replaced using atomicfile.
210
218
"""
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')
231
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
235
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
238
239
def print_file(self, file, revision_id):
219
220
fn = self.controlfilename(file_or_path)
221
222
if mode == 'rb' or mode == 'wb':
223
return file(fn, mode)
224
elif mode == 'r' or mode == 'w':
225
# open in binary mode anyhow so there's no newline translation;
226
# codecs uses line buffering by default; don't want that.
227
import codecs
228
return codecs.open(fn, mode + 'b', 'utf-8',
229
buffering=60000)
230
else:
231
raise BzrError("invalid controlfile mode %r" % mode)
232
233
234
235
def _make_control(self):
236
os.mkdir(self.controlfilename([]))
237
self.controlfile('README', 'w').write(
238
"This is a Bazaar-NG control directory.\n"
239
"Do not change any files in this directory.")
240
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
241
for d in ('text-store', 'inventory-store', 'revision-store'):
242
os.mkdir(self.controlfilename(d))
243
for f in ('revision-history', 'merged-patches',
244
'pending-merged-patches', 'branch-name',
245
'branch-lock'):
246
self.controlfile(f, 'w').write('')
247
mutter('created control directory in ' + self.base)
248
Inventory().write_xml(self.controlfile('inventory','w'))
249
250
251
def _check_format(self):
252
"""Check this branch format is supported.
253
254
The current tool only supports the current unstable format.
255
256
In the future, we might need different in-memory Branch
257
classes to support downlevel branches. But not yet.
258
"""
259
# This ignores newlines so that we can open branches created
260
# on Windows from Linux and so on. I think it might be better
261
# to always make all internal files in unix format.
262
fmt = self.controlfile('branch-format', 'r').read()
263
fmt.replace('\r\n', '')
264
if fmt != BZR_BRANCH_FORMAT:
265
bailout('sorry, branch format %r not supported' % fmt,
266
['use a different bzr version',
267
'or remove the .bzr directory and "bzr init" again'])
268
269
270
def read_working_inventory(self):
271
"""Read the working inventory."""
272
self._need_readlock()
273
before = time.time()
274
# ElementTree does its own conversion from UTF-8, so open in
275
# binary.
276
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
277
mutter("loaded inventory of %d items in %f"
278
% (len(inv), time.time() - before))
279
return inv
280
281
282
def _write_inventory(self, inv):
283
"""Update the working inventory.
284
285
That is to say, the inventory describing changes underway, that
286
will be committed to the next revision.
287
"""
288
self._need_writelock()
289
## TODO: factor out to atomicfile? is rename safe on windows?
290
## TODO: Maybe some kind of clean/dirty marker on inventory?
291
tmpfname = self.controlfilename('inventory.tmp')
292
tmpf = file(tmpfname, 'wb')
293
inv.write_xml(tmpf)
294
tmpf.close()
295
inv_fname = self.controlfilename('inventory')
296
if sys.platform == 'win32':
297
os.remove(inv_fname)
298
os.rename(tmpfname, inv_fname)
299
mutter('wrote working inventory')
300
301
302
inventory = property(read_working_inventory, _write_inventory, None,
303
"""Inventory for the working copy.""")
304
305
306
def add(self, files, verbose=False, ids=None):
307
"""Make files versioned.
308
309
Note that the command line normally calls smart_add instead.
310
311
This puts the files in the Added state, so that they will be
312
recorded by the next commit.
313
314
TODO: Perhaps have an option to add the ids even if the files do
315
not (yet) exist.
316
317
TODO: Perhaps return the ids of the files? But then again it
318
is easy to retrieve them if they're needed.
319
320
TODO: Option to specify file id.
321
322
TODO: Adding a directory should optionally recurse down and
323
add all non-ignored children. Perhaps do that in a
324
higher-level method.
325
"""
326
self._need_writelock()
327
328
# TODO: Re-adding a file that is removed in the working copy
329
# should probably put it back with the previous ID.
330
if isinstance(files, types.StringTypes):
331
assert(ids is None or isinstance(ids, types.StringTypes))
332
files = [files]
333
if ids is not None:
334
ids = [ids]
335
336
if ids is None:
337
ids = [None] * len(files)
338
else:
339
assert(len(ids) == len(files))
340
341
inv = self.read_working_inventory()
342
for f,file_id in zip(files, ids):
343
if is_control_file(f):
344
bailout("cannot add control file %s" % quotefn(f))
345
346
fp = splitpath(f)
347
348
if len(fp) == 0:
349
bailout("cannot add top-level %r" % f)
350
351
fullpath = os.path.normpath(self.abspath(f))
352
353
try:
354
kind = file_kind(fullpath)
355
except OSError:
356
# maybe something better?
357
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
358
359
if kind != 'file' and kind != 'directory':
360
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
361
362
if file_id is None:
363
file_id = gen_file_id(f)
364
inv.add_path(f, kind=kind, file_id=file_id)
365
366
if verbose:
367
show_status('A', kind, quotefn(f))
368
369
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
370
371
self._write_inventory(inv)
372
373
374
def print_file(self, file, revno):
240
375
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
242
243
def append_revision(self, *revision_ids):
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')
376
self._need_readlock()
377
tree = self.revision_tree(self.lookup_revision(revno))
378
# use inventory as it was in that revision
379
file_id = tree.inventory.path2id(file)
380
if not file_id:
381
bailout("%r is not present in revision %d" % (file, revno))
382
tree.print_file(file_id)
383
384
385
def remove(self, files, verbose=False):
386
"""Mark nominated files for removal from the inventory.
387
388
This does not remove their text. This does not run on
389
390
TODO: Refuse to remove modified files unless --force is given?
391
392
TODO: Do something useful with directories.
393
394
TODO: Should this remove the text or not? Tough call; not
395
removing may be useful and the user can just use use rm, and
396
is the opposite of add. Removing it is consistent with most
397
other tools. Maybe an option.
398
"""
399
## TODO: Normalize names
400
## TODO: Remove nested loops; better scalability
401
self._need_writelock()
402
403
if isinstance(files, types.StringTypes):
404
files = [files]
405
406
tree = self.working_tree()
407
inv = tree.inventory
408
409
# do this before any modifications
410
for f in files:
411
fid = inv.path2id(f)
412
if not fid:
413
bailout("cannot remove unversioned file %s" % quotefn(f))
414
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
415
if verbose:
416
# having remove it, it must be either ignored or unknown
417
if tree.is_ignored(f):
418
new_status = 'I'
419
else:
420
new_status = '?'
421
show_status(new_status, inv[fid].kind, quotefn(f))
422
del inv[fid]
423
424
self._write_inventory(inv)
425
426
def set_inventory(self, new_inventory_list):
427
inv = Inventory()
428
for path, file_id, parent, kind in new_inventory_list:
429
name = os.path.basename(path)
430
if name == "":
431
continue
432
inv.add(InventoryEntry(file_id, name, kind, parent))
433
self._write_inventory(inv)
434
435
436
def unknowns(self):
437
"""Return all unknown files.
438
439
These are files in the working directory that are not versioned or
440
control files or ignored.
441
442
>>> b = ScratchBranch(files=['foo', 'foo~'])
443
>>> list(b.unknowns())
444
['foo']
445
>>> b.add('foo')
446
>>> list(b.unknowns())
447
[]
448
>>> b.remove('foo')
449
>>> list(b.unknowns())
450
['foo']
451
"""
452
return self.working_tree().unknowns()
453
454
455
def append_revision(self, revision_id):
456
mutter("add {%s} to revision-history" % revision_id)
457
rev_history = self.revision_history()
458
459
tmprhname = self.controlfilename('revision-history.tmp')
460
rhname = self.controlfilename('revision-history')
461
462
f = file(tmprhname, 'wt')
463
rev_history.append(revision_id)
464
f.write('\n'.join(rev_history))
465
f.write('\n')
466
f.close()
467
468
if sys.platform == 'win32':
469
os.remove(rhname)
470
os.rename(tmprhname, rhname)
471
472
258
473
259
474
def get_revision(self, revision_id):
260
475
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
262
263
def get_revision_delta(self, revno):
264
"""Return the delta for one revision.
265
266
The delta is relative to its mainline predecessor, or the
267
empty tree for revision 1.
268
"""
269
assert isinstance(revno, int)
476
self._need_readlock()
477
r = Revision.read_xml(self.revision_store[revision_id])
478
assert r.revision_id == revision_id
479
return r
480
481
482
def get_inventory(self, inventory_id):
483
"""Get Inventory object by hash.
484
485
TODO: Perhaps for this and similar methods, take a revision
486
parameter which can be either an integer revno or a
487
string hash."""
488
self._need_readlock()
489
i = Inventory.read_xml(self.inventory_store[inventory_id])
490
return i
491
492
493
def get_revision_inventory(self, revision_id):
494
"""Return inventory of a past revision."""
495
self._need_readlock()
496
if revision_id == None:
497
return Inventory()
498
else:
499
return self.get_inventory(self.get_revision(revision_id).inventory_id)
500
501
502
def revision_history(self):
503
"""Return sequence of revision hashes on to this branch.
504
505
>>> ScratchBranch().revision_history()
506
[]
507
"""
508
self._need_readlock()
509
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
510
511
512
def enum_history(self, direction):
513
"""Return (revno, revision_id) for history of branch.
514
515
direction
516
'forward' is from earliest to latest
517
'reverse' is from latest to earliest
518
"""
270
519
rh = self.revision_history()
271
if not (1 <= revno <= len(rh)):
272
raise InvalidRevisionNumber(revno)
273
274
# revno is 1-based; list is 0-based
275
276
new_tree = self.revision_tree(rh[revno-1])
277
if revno == 1:
278
old_tree = EmptyTree()
520
if direction == 'forward':
521
i = 1
522
for rid in rh:
523
yield i, rid
524
i += 1
525
elif direction == 'reverse':
526
i = len(rh)
527
while i > 0:
528
yield i, rh[i-1]
529
i -= 1
279
530
else:
280
old_tree = self.revision_tree(rh[revno-2])
281
282
return compare_trees(old_tree, new_tree)
283
284
def get_revision_sha1(self, revision_id):
285
"""Hash the stored value of a revision, and return it."""
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):
301
"""Get inventory XML as a file object."""
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')
307
308
def get_revision_inventory(self, revision_id):
309
"""Return inventory of a past revision."""
310
raise NotImplementedError('get_revision_inventory is abstract')
311
312
def revision_history(self):
313
"""Return sequence of revision hashes on to this branch."""
314
raise NotImplementedError('revision_history is abstract')
531
raise BzrError('invalid history direction %r' % direction)
532
315
533
316
534
def revno(self):
317
535
"""Return current revision number for this branch.
321
539
"""
322
540
return len(self.revision_history())
323
541
324
def last_revision(self):
325
"""Return last patch hash, or None if no history."""
542
543
def last_patch(self):
544
"""Return last patch hash, or None if no history.
545
"""
326
546
ph = self.revision_history()
327
547
if ph:
328
548
return ph[-1]
329
549
else:
330
550
return None
331
551
332
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
333
"""Return a list of new revisions that would perfectly fit.
334
335
If self and other have not diverged, return a list of the revisions
336
present in other, but missing from self.
337
338
>>> from bzrlib.commit import commit
339
>>> bzrlib.trace.silent = True
340
>>> br1 = ScratchBranch()
341
>>> br2 = ScratchBranch()
342
>>> br1.missing_revisions(br2)
343
[]
344
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
345
>>> br1.missing_revisions(br2)
346
[u'REVISION-ID-1']
347
>>> br2.missing_revisions(br1)
348
[]
349
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
350
>>> br1.missing_revisions(br2)
351
[]
352
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
353
>>> br1.missing_revisions(br2)
354
[u'REVISION-ID-2A']
355
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
356
>>> br1.missing_revisions(br2)
357
Traceback (most recent call last):
358
DivergedBranches: These branches have diverged. Try merge.
359
"""
360
self_history = self.revision_history()
361
self_len = len(self_history)
362
other_history = other.revision_history()
363
other_len = len(other_history)
364
common_index = min(self_len, other_len) -1
365
if common_index >= 0 and \
366
self_history[common_index] != other_history[common_index]:
367
raise DivergedBranches(self, other)
368
369
if stop_revision is None:
370
stop_revision = other_len
371
else:
372
assert isinstance(stop_revision, int)
373
if stop_revision > other_len:
374
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
375
return other_history[self_len:stop_revision]
376
377
def update_revisions(self, other, stop_revision=None):
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')
383
384
def revision_id_to_revno(self, revision_id):
385
"""Given a revision id, return its revno"""
386
if revision_id is None:
387
return 0
388
history = self.revision_history()
389
try:
390
return history.index(revision_id) + 1
391
except ValueError:
392
raise bzrlib.errors.NoSuchRevision(self, revision_id)
393
394
def get_rev_id(self, revno, history=None):
395
"""Find the revision id of the specified revno."""
552
553
def commit(self, *args, **kw):
554
"""Deprecated"""
555
from bzrlib.commit import commit
556
commit(self, *args, **kw)
557
558
559
def lookup_revision(self, revno):
560
"""Return revision hash for revision number."""
396
561
if revno == 0:
397
562
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]
563
564
try:
565
# list is 0-based; revisions are 1-based
566
return self.revision_history()[revno-1]
567
except IndexError:
568
raise BzrError("no such revision %s" % revno)
569
403
570
404
571
def revision_tree(self, revision_id):
405
572
"""Return Tree for a revision on this branch.
406
573
407
574
`revision_id` may be None for the null revision, in which case
408
575
an `EmptyTree` is returned."""
409
raise NotImplementedError('revision_tree is abstract')
576
self._need_readlock()
577
if revision_id == None:
578
return EmptyTree()
579
else:
580
inv = self.get_revision_inventory(revision_id)
581
return RevisionTree(self.text_store, inv)
582
410
583
411
584
def working_tree(self):
412
"""Return a `Tree` for the working copy if this is a local branch."""
413
raise NotImplementedError('working_tree is abstract')
585
"""Return a `Tree` for the working copy."""
586
from workingtree import WorkingTree
587
return WorkingTree(self.base, self.read_working_inventory())
414
588
415
def pull(self, source, overwrite=False):
416
raise NotImplementedError('pull is abstract')
417
589
418
590
def basis_tree(self):
419
591
"""Return `Tree` object for last revision.
420
592
421
593
If there are no revisions yet, return an `EmptyTree`.
422
594
"""
423
return self.revision_tree(self.last_revision())
595
r = self.last_patch()
596
if r == None:
597
return EmptyTree()
598
else:
599
return RevisionTree(self.text_store, self.get_revision_inventory(r))
600
601
424
602
425
603
def rename_one(self, from_rel, to_rel):
426
604
"""Rename one file.
427
605
428
606
This can change the directory or the filename or both.
429
607
"""
430
raise NotImplementedError('rename_one is abstract')
608
self._need_writelock()
609
tree = self.working_tree()
610
inv = tree.inventory
611
if not tree.has_filename(from_rel):
612
bailout("can't rename: old working file %r does not exist" % from_rel)
613
if tree.has_filename(to_rel):
614
bailout("can't rename: new working file %r already exists" % to_rel)
615
616
file_id = inv.path2id(from_rel)
617
if file_id == None:
618
bailout("can't rename: old name %r is not versioned" % from_rel)
619
620
if inv.path2id(to_rel):
621
bailout("can't rename: new name %r is already versioned" % to_rel)
622
623
to_dir, to_tail = os.path.split(to_rel)
624
to_dir_id = inv.path2id(to_dir)
625
if to_dir_id == None and to_dir != '':
626
bailout("can't determine destination directory id for %r" % to_dir)
627
628
mutter("rename_one:")
629
mutter(" file_id {%s}" % file_id)
630
mutter(" from_rel %r" % from_rel)
631
mutter(" to_rel %r" % to_rel)
632
mutter(" to_dir %r" % to_dir)
633
mutter(" to_dir_id {%s}" % to_dir_id)
634
635
inv.rename(file_id, to_dir_id, to_tail)
636
637
print "%s => %s" % (from_rel, to_rel)
638
639
from_abs = self.abspath(from_rel)
640
to_abs = self.abspath(to_rel)
641
try:
642
os.rename(from_abs, to_abs)
643
except OSError, e:
644
bailout("failed to rename %r to %r: %s"
645
% (from_abs, to_abs, e[1]),
646
["rename rolled back"])
647
648
self._write_inventory(inv)
649
650
431
651
432
652
def move(self, from_paths, to_name):
433
653
"""Rename files.
439
659
440
660
Note that to_name is only the last component of the new name;
441
661
this doesn't change the directory.
442
443
This returns a list of (from_path, to_path) pairs for each
444
entry that is moved.
445
"""
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(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
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(name)
582
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
583
if self._transport.should_cache():
584
ws.enable_cache = True
585
return ws
586
587
if self._branch_format == 4:
588
self.inventory_store = get_store(u'inventory-store')
589
self.text_store = get_store(u'text-store')
590
self.revision_store = get_store(u'revision-store')
591
elif self._branch_format == 5:
592
self.control_weaves = get_weave(u'')
593
self.weave_store = get_weave(u'weaves')
594
self.revision_store = get_store(u'revision-store', compressed=False)
595
elif self._branch_format == 6:
596
self.control_weaves = get_weave(u'')
597
self.weave_store = get_weave(u'weaves', prefixed=True)
598
self.revision_store = get_store(u'revision-store', compressed=False,
599
prefixed=True)
600
self.revision_store.register_suffix('sig')
601
self._transaction = None
602
603
def __str__(self):
604
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
605
606
__repr__ = __str__
607
608
def __del__(self):
609
if self._lock_mode or self._lock:
610
# XXX: This should show something every time, and be suitable for
611
# headless operation and embedding
612
warn("branch %r was not explicitly unlocked" % self)
613
self._lock.unlock()
614
615
# TODO: It might be best to do this somewhere else,
616
# but it is nice for a Branch object to automatically
617
# cache it's information.
618
# Alternatively, we could have the Transport objects cache requests
619
# See the earlier discussion about how major objects (like Branch)
620
# should never expect their __del__ function to run.
621
if hasattr(self, 'cache_root') and self.cache_root is not None:
622
try:
623
shutil.rmtree(self.cache_root)
624
except:
625
pass
626
self.cache_root = None
627
628
def _get_base(self):
629
if self._transport:
630
return self._transport.base
631
return None
632
633
base = property(_get_base, doc="The URL for the root of this branch.")
634
635
def _finish_transaction(self):
636
"""Exit the current transaction."""
637
if self._transaction is None:
638
raise errors.LockError('Branch %s is not in a transaction' %
639
self)
640
transaction = self._transaction
641
self._transaction = None
642
transaction.finish()
643
644
def get_transaction(self):
645
"""See Branch.get_transaction."""
646
if self._transaction is None:
647
return transactions.PassThroughTransaction()
648
else:
649
return self._transaction
650
651
def _set_transaction(self, new_transaction):
652
"""Set a new active transaction."""
653
if self._transaction is not None:
654
raise errors.LockError('Branch %s is in a transaction already.' %
655
self)
656
self._transaction = new_transaction
657
658
def lock_write(self):
659
#mutter("lock write: %s (%s)", self, self._lock_count)
660
# TODO: Upgrade locking to support using a Transport,
661
# and potentially a remote locking protocol
662
if self._lock_mode:
663
if self._lock_mode != 'w':
664
raise LockError("can't upgrade to a write lock from %r" %
665
self._lock_mode)
666
self._lock_count += 1
667
else:
668
self._lock = self._transport.lock_write(
669
self._rel_controlfilename('branch-lock'))
670
self._lock_mode = 'w'
671
self._lock_count = 1
672
self._set_transaction(transactions.PassThroughTransaction())
673
674
def lock_read(self):
675
#mutter("lock read: %s (%s)", self, self._lock_count)
676
if self._lock_mode:
677
assert self._lock_mode in ('r', 'w'), \
678
"invalid lock mode %r" % self._lock_mode
679
self._lock_count += 1
680
else:
681
self._lock = self._transport.lock_read(
682
self._rel_controlfilename('branch-lock'))
683
self._lock_mode = 'r'
684
self._lock_count = 1
685
self._set_transaction(transactions.ReadOnlyTransaction())
686
# 5K may be excessive, but hey, its a knob.
687
self.get_transaction().set_cache_size(5000)
688
689
def unlock(self):
690
#mutter("unlock: %s (%s)", self, self._lock_count)
691
if not self._lock_mode:
692
raise LockError('branch %r is not locked' % (self))
693
694
if self._lock_count > 1:
695
self._lock_count -= 1
696
else:
697
self._finish_transaction()
698
self._lock.unlock()
699
self._lock = None
700
self._lock_mode = self._lock_count = None
701
702
def abspath(self, name):
703
"""See Branch.abspath."""
704
return self._transport.abspath(name)
705
706
def _rel_controlfilename(self, file_or_path):
707
if not isinstance(file_or_path, basestring):
708
file_or_path = u'/'.join(file_or_path)
709
if file_or_path == '':
710
return bzrlib.BZRDIR
711
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
712
713
def controlfilename(self, file_or_path):
714
"""See Branch.controlfilename."""
715
return self._transport.abspath(self._rel_controlfilename(file_or_path))
716
717
def controlfile(self, file_or_path, mode='r'):
718
"""See Branch.controlfile."""
719
import codecs
720
721
relpath = self._rel_controlfilename(file_or_path)
722
#TODO: codecs.open() buffers linewise, so it was overloaded with
723
# a much larger buffer, do we need to do the same for getreader/getwriter?
724
if mode == 'rb':
725
return self._transport.get(relpath)
726
elif mode == 'wb':
727
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
728
elif mode == 'r':
729
# XXX: Do we really want errors='replace'? Perhaps it should be
730
# an error, or at least reported, if there's incorrectly-encoded
731
# data inside a file.
732
# <https://launchpad.net/products/bzr/+bug/3823>
733
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
734
elif mode == 'w':
735
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
736
else:
737
raise BzrError("invalid controlfile mode %r" % mode)
738
739
def put_controlfile(self, path, f, encode=True):
740
"""See Branch.put_controlfile."""
741
self.put_controlfiles([(path, f)], encode=encode)
742
743
def put_controlfiles(self, files, encode=True):
744
"""See Branch.put_controlfiles."""
745
import codecs
746
ctrl_files = []
747
for path, f in files:
748
if encode:
749
if isinstance(f, basestring):
750
f = f.encode('utf-8', 'replace')
751
else:
752
f = codecs.getwriter('utf-8')(f, errors='replace')
753
path = self._rel_controlfilename(path)
754
ctrl_files.append((path, f))
755
self._transport.put_multi(ctrl_files)
756
757
def _make_control(self):
758
from bzrlib.inventory import Inventory
759
from bzrlib.weavefile import write_weave_v5
760
from bzrlib.weave import Weave
761
762
# Create an empty inventory
763
sio = StringIO()
764
# if we want per-tree root ids then this is the place to set
765
# them; they're not needed for now and so ommitted for
766
# simplicity.
767
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
768
empty_inv = sio.getvalue()
769
sio = StringIO()
770
bzrlib.weavefile.write_weave_v5(Weave(), sio)
771
empty_weave = sio.getvalue()
772
773
dirs = [[], 'revision-store', 'weaves']
774
files = [('README',
775
"This is a Bazaar-NG control directory.\n"
776
"Do not change any files in this directory.\n"),
777
('branch-format', BZR_BRANCH_FORMAT_6),
778
('revision-history', ''),
779
('branch-name', ''),
780
('branch-lock', ''),
781
('pending-merges', ''),
782
('inventory', empty_inv),
783
('inventory.weave', empty_weave),
784
('ancestry.weave', empty_weave)
785
]
786
cfn = self._rel_controlfilename
787
self._transport.mkdir_multi([cfn(d) for d in dirs])
788
self.put_controlfiles(files)
789
mutter('created control directory in ' + self._transport.base)
790
791
def _check_format(self, relax_version_check):
792
"""Check this branch format is supported.
793
794
The format level is stored, as an integer, in
795
self._branch_format for code that needs to check it later.
796
797
In the future, we might need different in-memory Branch
798
classes to support downlevel branches. But not yet.
799
"""
800
try:
801
fmt = self.controlfile('branch-format', 'r').read()
802
except NoSuchFile:
803
raise NotBranchError(path=self.base)
804
mutter("got branch format %r", fmt)
805
if fmt == BZR_BRANCH_FORMAT_6:
806
self._branch_format = 6
807
elif fmt == BZR_BRANCH_FORMAT_5:
808
self._branch_format = 5
809
elif fmt == BZR_BRANCH_FORMAT_4:
810
self._branch_format = 4
811
812
if (not relax_version_check
813
and self._branch_format not in (5, 6)):
814
raise errors.UnsupportedFormatError(
815
'sorry, branch format %r not supported' % fmt,
816
['use a different bzr version',
817
'or remove the .bzr directory'
818
' and "bzr init" again'])
819
820
@needs_read_lock
821
def get_root_id(self):
822
"""See Branch.get_root_id."""
823
inv = self.get_inventory(self.last_revision())
824
return inv.root.file_id
825
826
@needs_read_lock
827
def print_file(self, file, revision_id):
828
"""See Branch.print_file."""
829
tree = self.revision_tree(revision_id)
830
# use inventory as it was in that revision
831
file_id = tree.inventory.path2id(file)
832
if not file_id:
833
try:
834
revno = self.revision_id_to_revno(revision_id)
835
except errors.NoSuchRevision:
836
# TODO: This should not be BzrError,
837
# but NoSuchFile doesn't fit either
838
raise BzrError('%r is not present in revision %s'
839
% (file, revision_id))
840
else:
841
raise BzrError('%r is not present in revision %s'
842
% (file, revno))
843
tree.print_file(file_id)
844
845
@needs_write_lock
846
def append_revision(self, *revision_ids):
847
"""See Branch.append_revision."""
848
for revision_id in revision_ids:
849
mutter("add {%s} to revision-history" % revision_id)
850
rev_history = self.revision_history()
851
rev_history.extend(revision_ids)
852
self.set_revision_history(rev_history)
853
854
@needs_write_lock
855
def set_revision_history(self, rev_history):
856
"""See Branch.set_revision_history."""
857
old_revision = self.last_revision()
858
new_revision = rev_history[-1]
859
self.put_controlfile('revision-history', '\n'.join(rev_history))
860
try:
861
self.working_tree().set_last_revision(new_revision, old_revision)
862
except NoWorkingTree:
863
mutter('Unable to set_last_revision without a working tree.')
864
865
def has_revision(self, revision_id):
866
"""See Branch.has_revision."""
867
return (revision_id is None
868
or self.revision_store.has_id(revision_id))
869
870
@needs_read_lock
871
def _get_revision_xml_file(self, revision_id):
872
if not revision_id or not isinstance(revision_id, basestring):
873
raise InvalidRevisionId(revision_id=revision_id, branch=self)
874
try:
875
return self.revision_store.get(revision_id)
876
except (IndexError, KeyError):
877
raise bzrlib.errors.NoSuchRevision(self, revision_id)
878
879
def get_revision_xml(self, revision_id):
880
"""See Branch.get_revision_xml."""
881
return self._get_revision_xml_file(revision_id).read()
882
883
def get_revision(self, revision_id):
884
"""See Branch.get_revision."""
885
xml_file = self._get_revision_xml_file(revision_id)
886
887
try:
888
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
889
except SyntaxError, e:
890
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
891
[revision_id,
892
str(e)])
893
894
assert r.revision_id == revision_id
895
return r
896
897
def get_revision_sha1(self, revision_id):
898
"""See Branch.get_revision_sha1."""
899
# In the future, revision entries will be signed. At that
900
# point, it is probably best *not* to include the signature
901
# in the revision hash. Because that lets you re-sign
902
# the revision, (add signatures/remove signatures) and still
903
# have all hash pointers stay consistent.
904
# But for now, just hash the contents.
905
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
906
907
def get_ancestry(self, revision_id):
908
"""See Branch.get_ancestry."""
909
if revision_id is None:
910
return [None]
911
w = self._get_inventory_weave()
912
return [None] + map(w.idx_to_name,
913
w.inclusions([w.lookup(revision_id)]))
914
915
def _get_inventory_weave(self):
916
return self.control_weaves.get_weave('inventory',
917
self.get_transaction())
918
919
def get_inventory(self, revision_id):
920
"""See Branch.get_inventory."""
921
xml = self.get_inventory_xml(revision_id)
922
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
923
924
def get_inventory_xml(self, revision_id):
925
"""See Branch.get_inventory_xml."""
926
try:
927
assert isinstance(revision_id, basestring), type(revision_id)
928
iw = self._get_inventory_weave()
929
return iw.get_text(iw.lookup(revision_id))
930
except IndexError:
931
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
932
933
def get_inventory_sha1(self, revision_id):
934
"""See Branch.get_inventory_sha1."""
935
return self.get_revision(revision_id).inventory_sha1
936
937
def get_revision_inventory(self, revision_id):
938
"""See Branch.get_revision_inventory."""
939
# TODO: Unify this with get_inventory()
940
# bzr 0.0.6 and later imposes the constraint that the inventory_id
941
# must be the same as its revision, so this is trivial.
942
if revision_id == None:
943
# This does not make sense: if there is no revision,
944
# then it is the current tree inventory surely ?!
945
# and thus get_root_id() is something that looks at the last
946
# commit on the branch, and the get_root_id is an inventory check.
947
raise NotImplementedError
948
# return Inventory(self.get_root_id())
949
else:
950
return self.get_inventory(revision_id)
951
952
@needs_read_lock
953
def revision_history(self):
954
"""See Branch.revision_history."""
955
transaction = self.get_transaction()
956
history = transaction.map.find_revision_history()
957
if history is not None:
958
mutter("cache hit for revision-history in %s", self)
959
return list(history)
960
history = [l.rstrip('\r\n') for l in
961
self.controlfile('revision-history', 'r').readlines()]
962
transaction.map.add_revision_history(history)
963
# this call is disabled because revision_history is
964
# not really an object yet, and the transaction is for objects.
965
# transaction.register_clean(history, precious=True)
966
return list(history)
967
968
def update_revisions(self, other, stop_revision=None):
969
"""See Branch.update_revisions."""
970
from bzrlib.fetch import greedy_fetch
971
if stop_revision is None:
972
stop_revision = other.last_revision()
973
### Should this be checking is_ancestor instead of revision_history?
974
if (stop_revision is not None and
975
stop_revision in self.revision_history()):
976
return
977
greedy_fetch(to_branch=self, from_branch=other,
978
revision=stop_revision)
979
pullable_revs = self.pullable_revisions(other, stop_revision)
980
if len(pullable_revs) > 0:
981
self.append_revision(*pullable_revs)
982
983
def pullable_revisions(self, other, stop_revision):
984
"""See Branch.pullable_revisions."""
985
other_revno = other.revision_id_to_revno(stop_revision)
986
try:
987
return self.missing_revisions(other, other_revno)
988
except DivergedBranches, e:
989
try:
990
pullable_revs = get_intervening_revisions(self.last_revision(),
991
stop_revision, self)
992
assert self.last_revision() not in pullable_revs
993
return pullable_revs
994
except bzrlib.errors.NotAncestor:
995
if is_ancestor(self.last_revision(), stop_revision, self):
996
return []
997
else:
998
raise e
999
1000
def revision_tree(self, revision_id):
1001
"""See Branch.revision_tree."""
1002
# TODO: refactor this to use an existing revision object
1003
# so we don't need to read it in twice.
1004
if revision_id == None or revision_id == NULL_REVISION:
1005
return EmptyTree()
1006
else:
1007
inv = self.get_revision_inventory(revision_id)
1008
return RevisionTree(self.weave_store, inv, revision_id)
1009
1010
def basis_tree(self):
1011
"""See Branch.basis_tree."""
1012
try:
1013
revision_id = self.revision_history()[-1]
1014
xml = self.working_tree().read_basis_inventory(revision_id)
1015
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1016
return RevisionTree(self.weave_store, inv, revision_id)
1017
except (IndexError, NoSuchFile, NoWorkingTree), e:
1018
return self.revision_tree(self.last_revision())
1019
1020
def working_tree(self):
1021
"""See Branch.working_tree."""
1022
from bzrlib.workingtree import WorkingTree
1023
if self._transport.base.find('://') != -1:
1024
raise NoWorkingTree(self.base)
1025
return WorkingTree(self.base, branch=self)
1026
1027
@needs_write_lock
1028
def pull(self, source, overwrite=False):
1029
"""See Branch.pull."""
1030
source.lock_read()
1031
try:
1032
old_count = len(self.revision_history())
1033
try:
1034
self.update_revisions(source)
1035
except DivergedBranches:
1036
if not overwrite:
1037
raise
1038
if overwrite:
1039
self.set_revision_history(source.revision_history())
1040
new_count = len(self.revision_history())
1041
return new_count - old_count
1042
finally:
1043
source.unlock()
1044
1045
def get_parent(self):
1046
"""See Branch.get_parent."""
1047
import errno
1048
_locs = ['parent', 'pull', 'x-pull']
1049
for l in _locs:
1050
try:
1051
return self.controlfile(l, 'r').read().strip('\n')
1052
except NoSuchFile:
1053
pass
1054
return None
1055
1056
def get_push_location(self):
1057
"""See Branch.get_push_location."""
1058
config = bzrlib.config.BranchConfig(self)
1059
push_loc = config.get_user_option('push_location')
1060
return push_loc
1061
1062
def set_push_location(self, location):
1063
"""See Branch.set_push_location."""
1064
config = bzrlib.config.LocationConfig(self.base)
1065
config.set_user_option('push_location', location)
1066
1067
@needs_write_lock
1068
def set_parent(self, url):
1069
"""See Branch.set_parent."""
1070
# TODO: Maybe delete old location files?
1071
from bzrlib.atomicfile import AtomicFile
1072
f = AtomicFile(self.controlfilename('parent'))
1073
try:
1074
f.write(url + '\n')
1075
f.commit()
1076
finally:
1077
f.close()
1078
1079
def tree_config(self):
1080
return TreeConfig(self)
1081
1082
def sign_revision(self, revision_id, gpg_strategy):
1083
"""See Branch.sign_revision."""
1084
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1085
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1086
1087
@needs_write_lock
1088
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1089
"""See Branch.store_revision_signature."""
1090
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1091
revision_id, "sig")
1092
1093
1094
class ScratchBranch(BzrBranch):
662
"""
663
self._need_writelock()
664
## TODO: Option to move IDs only
665
assert not isinstance(from_paths, basestring)
666
tree = self.working_tree()
667
inv = tree.inventory
668
to_abs = self.abspath(to_name)
669
if not isdir(to_abs):
670
bailout("destination %r is not a directory" % to_abs)
671
if not tree.has_filename(to_name):
672
bailout("destination %r not in working directory" % to_abs)
673
to_dir_id = inv.path2id(to_name)
674
if to_dir_id == None and to_name != '':
675
bailout("destination %r is not a versioned directory" % to_name)
676
to_dir_ie = inv[to_dir_id]
677
if to_dir_ie.kind not in ('directory', 'root_directory'):
678
bailout("destination %r is not a directory" % to_abs)
679
680
to_idpath = Set(inv.get_idpath(to_dir_id))
681
682
for f in from_paths:
683
if not tree.has_filename(f):
684
bailout("%r does not exist in working tree" % f)
685
f_id = inv.path2id(f)
686
if f_id == None:
687
bailout("%r is not versioned" % f)
688
name_tail = splitpath(f)[-1]
689
dest_path = appendpath(to_name, name_tail)
690
if tree.has_filename(dest_path):
691
bailout("destination %r already exists" % dest_path)
692
if f_id in to_idpath:
693
bailout("can't move %r to a subdirectory of itself" % f)
694
695
# OK, so there's a race here, it's possible that someone will
696
# create a file in this interval and then the rename might be
697
# left half-done. But we should have caught most problems.
698
699
for f in from_paths:
700
name_tail = splitpath(f)[-1]
701
dest_path = appendpath(to_name, name_tail)
702
print "%s => %s" % (f, dest_path)
703
inv.rename(inv.path2id(f), to_dir_id, name_tail)
704
try:
705
os.rename(self.abspath(f), self.abspath(dest_path))
706
except OSError, e:
707
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
708
["rename rolled back"])
709
710
self._write_inventory(inv)
711
712
713
714
715
class ScratchBranch(Branch):
1095
716
"""Special test class: a branch that cleans up after itself.
1096
717
1097
718
>>> b = ScratchBranch()
1098
719
>>> isdir(b.base)
1099
720
True
1100
721
>>> bd = b.base
1101
>>> b._transport.__del__()
722
>>> b.destroy()
1102
723
>>> isdir(bd)
1103
724
False
1104
725
"""
1105
1106
def __init__(self, files=[], dirs=[], transport=None):
726
def __init__(self, files=[], dirs=[]):
1107
727
"""Make a test branch.
1108
728
1109
729
This creates a temporary directory and runs init-tree in it.
1110
730
1111
731
If any files are listed, they are created in the working copy.
1112
732
"""
1113
if transport is None:
1114
transport = bzrlib.transport.local.ScratchTransport()
1115
super(ScratchBranch, self).__init__(transport, init=True)
1116
else:
1117
super(ScratchBranch, self).__init__(transport)
1118
733
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1119
734
for d in dirs:
1120
self._transport.mkdir(d)
735
os.mkdir(self.abspath(d))
1121
736
1122
737
for f in files:
1123
self._transport.put(f, 'content of %s' % f)
1124
1125
1126
def clone(self):
1127
"""
1128
>>> orig = ScratchBranch(files=["file1", "file2"])
1129
>>> clone = orig.clone()
1130
>>> if os.name != 'nt':
1131
... os.path.samefile(orig.base, clone.base)
1132
... else:
1133
... orig.base == clone.base
1134
...
1135
False
1136
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1137
True
1138
"""
1139
from shutil import copytree
1140
from tempfile import mkdtemp
1141
base = mkdtemp()
1142
os.rmdir(base)
1143
copytree(self.base, base, symlinks=True)
1144
return ScratchBranch(
1145
transport=bzrlib.transport.local.ScratchTransport(base))
738
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
739
740
741
def __del__(self):
742
self.destroy()
743
744
def destroy(self):
745
"""Destroy the test branch, removing the scratch directory."""
746
try:
747
mutter("delete ScratchBranch %s" % self.base)
748
shutil.rmtree(self.base)
749
except OSError, e:
750
# Work around for shutil.rmtree failing on Windows when
751
# readonly files are encountered
752
mutter("hit exception in destroying ScratchBranch: %s" % e)
753
for root, dirs, files in os.walk(self.base, topdown=False):
754
for name in files:
755
os.chmod(os.path.join(root, name), 0700)
756
shutil.rmtree(self.base)
757
self.base = None
758
1146
759
1147
760
1148
761
######################################################################
1161
774
break
1162
775
filename = head
1163
776
return False
777
778
779
780
def gen_file_id(name):
781
"""Return new file id.
782
783
This should probably generate proper UUIDs, but for the moment we
784
cope with just randomness because running uuidgen every time is
785
slow."""
786
idx = name.rfind('/')
787
if idx != -1:
788
name = name[idx+1 : ]
789
idx = name.rfind('\\')
790
if idx != -1:
791
name = name[idx+1 : ]
792
793
name = name.lstrip('.')
794
795
s = hexlify(rand_bytes(8))
796
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1