« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 236
- compare with another revision
- download diff
- download tarball
- view history from revision 236
- Committer: mbp at sourcefrog
- Date: 2005-04-11 02:44:45 UTC
- Revision ID: mbp@sourcefrog.net-20050411024445-a2d4fa7e39309d2300533a6a
- Experiments in inventory performance
- files added:
- bzrlib/mdiff.py
- files removed:
- HACKING
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/store/__init__.py => bzrlib/store.py
- 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, WorkingTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
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
from diff import diff_trees
37
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
59
39
## TODO: Maybe include checks for common corruption of newlines, etc?
60
40
61
41
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
42
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
45
46
It is not necessary that f exists.
47
48
Basically we keep looking up until we find the control directory or
49
run into the root."""
50
if f == None:
51
f = os.getcwd()
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
54
else:
55
f = os.path.abspath(f)
56
57
orig_f = f
58
59
while True:
60
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
61
return f
62
head, tail = os.path.split(f)
63
if head == f:
64
# reached the root, whatever that may be
65
raise BzrError('%r is not in a branch' % orig_f)
66
f = head
67
68
93
69
94
70
######################################################################
95
71
# branch objects
96
72
97
class Branch(object):
73
class Branch:
98
74
"""Branch holding a history of revisions.
99
75
100
base
101
Base directory/url of the branch.
76
:todo: Perhaps use different stores for different classes of object,
77
so that we can keep track of how much space each one uses,
78
or garbage-collect them.
79
80
:todo: Add a RemoteBranch subclass. For the basic case of read-only
81
HTTP access this should be very easy by,
82
just redirecting controlfile access into HTTP requests.
83
We would need a RemoteStore working similarly.
84
85
:todo: Keep the on-disk branch locked while the object exists.
86
87
:todo: mkdir() method.
102
88
"""
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.
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')
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')
89
def __init__(self, base, init=False, find_root=True):
90
"""Create new branch object at a particular location.
91
92
:param base: Base directory for the branch.
93
94
:param init: If True, create new control files in a previously
95
unversioned directory. If False, the branch must already
96
be versioned.
97
98
:param find_root: If true and init is false, find the root of the
99
existing branch containing base.
100
101
In the test suite, creation of new trees is tested using the
102
`ScratchBranch` class.
103
"""
104
if init:
105
self.base = os.path.realpath(base)
106
self._make_control()
107
elif find_root:
108
self.base = find_branch_root(base)
109
else:
110
self.base = os.path.realpath(base)
111
if not isdir(self.controlfilename('.')):
112
bailout("not a bzr branch: %s" % quotefn(base),
113
['use "bzr init" to initialize a new working tree',
114
'current bzr can only operate from top-of-tree'])
115
self._check_format()
116
117
self.text_store = ImmutableStore(self.controlfilename('text-store'))
118
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
119
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
120
121
122
def __str__(self):
123
return '%s(%r)' % (self.__class__.__name__, self.base)
124
125
126
__repr__ = __str__
127
187
128
188
129
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')
130
"""Return absolute filename for something in the branch"""
131
return os.path.join(self.base, name)
132
133
134
def relpath(self, path):
135
"""Return path relative to this branch of something inside it.
136
137
Raises an error if path is not in this branch."""
138
rp = os.path.realpath(path)
139
# FIXME: windows
140
if not rp.startswith(self.base):
141
bailout("path %r is not within branch %r" % (rp, self.base))
142
rp = rp[len(self.base):]
143
rp = rp.lstrip(os.sep)
144
return rp
145
195
146
196
147
def controlfilename(self, file_or_path):
197
148
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
149
if isinstance(file_or_path, types.StringTypes):
150
file_or_path = [file_or_path]
151
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
152
199
153
200
154
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
202
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
207
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
210
"""
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')
155
"""Open a control file for this branch"""
156
return file(self.controlfilename(file_or_path), mode)
157
158
159
def _make_control(self):
160
os.mkdir(self.controlfilename([]))
161
self.controlfile('README', 'w').write(
162
"This is a Bazaar-NG control directory.\n"
163
"Do not change any files in this directory.")
164
self.controlfile('branch-format', 'wb').write(BZR_BRANCH_FORMAT)
165
for d in ('text-store', 'inventory-store', 'revision-store'):
166
os.mkdir(self.controlfilename(d))
167
for f in ('revision-history', 'merged-patches',
168
'pending-merged-patches', 'branch-name'):
169
self.controlfile(f, 'w').write('')
170
mutter('created control directory in ' + self.base)
171
Inventory().write_xml(self.controlfile('inventory','w'))
172
173
174
def _check_format(self):
175
"""Check this branch format is supported.
176
177
The current tool only supports the current unstable format.
178
179
In the future, we might need different in-memory Branch
180
classes to support downlevel branches. But not yet.
181
"""
182
# This ignores newlines so that we can open branches created
183
# on Windows from Linux and so on. I think it might be better
184
# to always make all internal files in unix format.
185
fmt = self.controlfile('branch-format', 'rb').read()
186
fmt.replace('\r\n', '')
187
if fmt != BZR_BRANCH_FORMAT:
188
bailout('sorry, branch format %r not supported' % fmt,
189
['use a different bzr version',
190
'or remove the .bzr directory and "bzr init" again'])
191
192
193
def read_working_inventory(self):
194
"""Read the working inventory."""
195
before = time.time()
196
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
197
mutter("loaded inventory of %d items in %f"
198
% (len(inv), time.time() - before))
199
return inv
200
201
202
def _write_inventory(self, inv):
203
"""Update the working inventory.
204
205
That is to say, the inventory describing changes underway, that
206
will be committed to the next revision.
207
"""
208
## TODO: factor out to atomicfile? is rename safe on windows?
209
## TODO: Maybe some kind of clean/dirty marker on inventory?
210
tmpfname = self.controlfilename('inventory.tmp')
211
tmpf = file(tmpfname, 'w')
212
inv.write_xml(tmpf)
213
tmpf.close()
214
inv_fname = self.controlfilename('inventory')
215
if sys.platform == 'win32':
216
os.remove(inv_fname)
217
os.rename(tmpfname, inv_fname)
218
mutter('wrote working inventory')
219
220
221
inventory = property(read_working_inventory, _write_inventory, None,
222
"""Inventory for the working copy.""")
223
224
225
def add(self, files, verbose=False):
226
"""Make files versioned.
227
228
This puts the files in the Added state, so that they will be
229
recorded by the next commit.
230
231
:todo: Perhaps have an option to add the ids even if the files do
232
not (yet) exist.
233
234
:todo: Perhaps return the ids of the files? But then again it
235
is easy to retrieve them if they're needed.
236
237
:todo: Option to specify file id.
238
239
:todo: Adding a directory should optionally recurse down and
240
add all non-ignored children. Perhaps do that in a
241
higher-level method.
242
243
>>> b = ScratchBranch(files=['foo'])
244
>>> 'foo' in b.unknowns()
245
True
246
>>> b.show_status()
247
? foo
248
>>> b.add('foo')
249
>>> 'foo' in b.unknowns()
250
False
251
>>> bool(b.inventory.path2id('foo'))
252
True
253
>>> b.show_status()
254
A foo
255
256
>>> b.add('foo')
257
Traceback (most recent call last):
258
...
259
BzrError: ('foo is already versioned', [])
260
261
>>> b.add(['nothere'])
262
Traceback (most recent call last):
263
BzrError: ('cannot add: not a regular file or directory: nothere', [])
264
"""
265
266
# TODO: Re-adding a file that is removed in the working copy
267
# should probably put it back with the previous ID.
268
if isinstance(files, types.StringTypes):
269
files = [files]
270
271
inv = self.read_working_inventory()
272
for f in files:
273
if is_control_file(f):
274
bailout("cannot add control file %s" % quotefn(f))
275
276
fp = splitpath(f)
277
278
if len(fp) == 0:
279
bailout("cannot add top-level %r" % f)
280
281
fullpath = os.path.normpath(self.abspath(f))
282
283
try:
284
kind = file_kind(fullpath)
285
except OSError:
286
# maybe something better?
287
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
288
289
if kind != 'file' and kind != 'directory':
290
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
291
292
file_id = gen_file_id(f)
293
inv.add_path(f, kind=kind, file_id=file_id)
294
295
if verbose:
296
show_status('A', kind, quotefn(f))
297
298
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
299
300
self._write_inventory(inv)
301
238
302
239
303
def print_file(self, file, revno):
240
304
"""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')
305
tree = self.revision_tree(self.lookup_revision(revno))
306
# use inventory as it was in that revision
307
file_id = tree.inventory.path2id(file)
308
if not file_id:
309
bailout("%r is not present in revision %d" % (file, revno))
310
tree.print_file(file_id)
311
312
313
def remove(self, files, verbose=False):
314
"""Mark nominated files for removal from the inventory.
315
316
This does not remove their text. This does not run on
317
318
:todo: Refuse to remove modified files unless --force is given?
319
320
>>> b = ScratchBranch(files=['foo'])
321
>>> b.add('foo')
322
>>> b.inventory.has_filename('foo')
323
True
324
>>> b.remove('foo')
325
>>> b.working_tree().has_filename('foo')
326
True
327
>>> b.inventory.has_filename('foo')
328
False
329
330
>>> b = ScratchBranch(files=['foo'])
331
>>> b.add('foo')
332
>>> b.commit('one')
333
>>> b.remove('foo')
334
>>> b.commit('two')
335
>>> b.inventory.has_filename('foo')
336
False
337
>>> b.basis_tree().has_filename('foo')
338
False
339
>>> b.working_tree().has_filename('foo')
340
True
341
342
:todo: Do something useful with directories.
343
344
:todo: Should this remove the text or not? Tough call; not
345
removing may be useful and the user can just use use rm, and
346
is the opposite of add. Removing it is consistent with most
347
other tools. Maybe an option.
348
"""
349
## TODO: Normalize names
350
## TODO: Remove nested loops; better scalability
351
352
if isinstance(files, types.StringTypes):
353
files = [files]
354
355
tree = self.working_tree()
356
inv = tree.inventory
357
358
# do this before any modifications
359
for f in files:
360
fid = inv.path2id(f)
361
if not fid:
362
bailout("cannot remove unversioned file %s" % quotefn(f))
363
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
364
if verbose:
365
# having remove it, it must be either ignored or unknown
366
if tree.is_ignored(f):
367
new_status = 'I'
368
else:
369
new_status = '?'
370
show_status(new_status, inv[fid].kind, quotefn(f))
371
del inv[fid]
372
373
self._write_inventory(inv)
374
375
376
def unknowns(self):
377
"""Return all unknown files.
378
379
These are files in the working directory that are not versioned or
380
control files or ignored.
381
382
>>> b = ScratchBranch(files=['foo', 'foo~'])
383
>>> list(b.unknowns())
384
['foo']
385
>>> b.add('foo')
386
>>> list(b.unknowns())
387
[]
388
>>> b.remove('foo')
389
>>> list(b.unknowns())
390
['foo']
391
"""
392
return self.working_tree().unknowns()
393
394
395
def commit(self, message, timestamp=None, timezone=None,
396
committer=None,
397
verbose=False):
398
"""Commit working copy as a new revision.
399
400
The basic approach is to add all the file texts into the
401
store, then the inventory, then make a new revision pointing
402
to that inventory and store that.
403
404
This is not quite safe if the working copy changes during the
405
commit; for the moment that is simply not allowed. A better
406
approach is to make a temporary copy of the files before
407
computing their hashes, and then add those hashes in turn to
408
the inventory. This should mean at least that there are no
409
broken hash pointers. There is no way we can get a snapshot
410
of the whole directory at an instant. This would also have to
411
be robust against files disappearing, moving, etc. So the
412
whole thing is a bit hard.
413
414
:param timestamp: if not None, seconds-since-epoch for a
415
postdated/predated commit.
416
"""
417
418
## TODO: Show branch names
419
420
# TODO: Don't commit if there are no changes, unless forced?
421
422
# First walk over the working inventory; and both update that
423
# and also build a new revision inventory. The revision
424
# inventory needs to hold the text-id, sha1 and size of the
425
# actual file versions committed in the revision. (These are
426
# not present in the working inventory.) We also need to
427
# detect missing/deleted files, and remove them from the
428
# working inventory.
429
430
work_inv = self.read_working_inventory()
431
inv = Inventory()
432
basis = self.basis_tree()
433
basis_inv = basis.inventory
434
missing_ids = []
435
for path, entry in work_inv.iter_entries():
436
## TODO: Cope with files that have gone missing.
437
438
## TODO: Check that the file kind has not changed from the previous
439
## revision of this file (if any).
440
441
entry = entry.copy()
442
443
p = self.abspath(path)
444
file_id = entry.file_id
445
mutter('commit prep file %s, id %r ' % (p, file_id))
446
447
if not os.path.exists(p):
448
mutter(" file is missing, removing from inventory")
449
if verbose:
450
show_status('D', entry.kind, quotefn(path))
451
missing_ids.append(file_id)
452
continue
453
454
# TODO: Handle files that have been deleted
455
456
# TODO: Maybe a special case for empty files? Seems a
457
# waste to store them many times.
458
459
inv.add(entry)
460
461
if basis_inv.has_id(file_id):
462
old_kind = basis_inv[file_id].kind
463
if old_kind != entry.kind:
464
bailout("entry %r changed kind from %r to %r"
465
% (file_id, old_kind, entry.kind))
466
467
if entry.kind == 'directory':
468
if not isdir(p):
469
bailout("%s is entered as directory but not a directory" % quotefn(p))
470
elif entry.kind == 'file':
471
if not isfile(p):
472
bailout("%s is entered as file but is not a file" % quotefn(p))
473
474
content = file(p, 'rb').read()
475
476
entry.text_sha1 = sha_string(content)
477
entry.text_size = len(content)
478
479
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
480
if (old_ie
481
and (old_ie.text_size == entry.text_size)
482
and (old_ie.text_sha1 == entry.text_sha1)):
483
## assert content == basis.get_file(file_id).read()
484
entry.text_id = basis_inv[file_id].text_id
485
mutter(' unchanged from previous text_id {%s}' %
486
entry.text_id)
487
488
else:
489
entry.text_id = gen_file_id(entry.name)
490
self.text_store.add(content, entry.text_id)
491
mutter(' stored with text_id {%s}' % entry.text_id)
492
if verbose:
493
if not old_ie:
494
state = 'A'
495
elif (old_ie.name == entry.name
496
and old_ie.parent_id == entry.parent_id):
497
state = 'M'
498
else:
499
state = 'R'
500
501
show_status(state, entry.kind, quotefn(path))
502
503
for file_id in missing_ids:
504
# have to do this later so we don't mess up the iterator.
505
# since parents may be removed before their children we
506
# have to test.
507
508
# FIXME: There's probably a better way to do this; perhaps
509
# the workingtree should know how to filter itself.
510
if work_inv.has_id(file_id):
511
del work_inv[file_id]
512
513
514
inv_id = rev_id = _gen_revision_id(time.time())
515
516
inv_tmp = tempfile.TemporaryFile()
517
inv.write_xml(inv_tmp)
518
inv_tmp.seek(0)
519
self.inventory_store.add(inv_tmp, inv_id)
520
mutter('new inventory_id is {%s}' % inv_id)
521
522
self._write_inventory(work_inv)
523
524
if timestamp == None:
525
timestamp = time.time()
526
527
if committer == None:
528
committer = username()
529
530
if timezone == None:
531
timezone = local_time_offset()
532
533
mutter("building commit log message")
534
rev = Revision(timestamp=timestamp,
535
timezone=timezone,
536
committer=committer,
537
precursor = self.last_patch(),
538
message = message,
539
inventory_id=inv_id,
540
revision_id=rev_id)
541
542
rev_tmp = tempfile.TemporaryFile()
543
rev.write_xml(rev_tmp)
544
rev_tmp.seek(0)
545
self.revision_store.add(rev_tmp, rev_id)
546
mutter("new revision_id is {%s}" % rev_id)
547
548
## XXX: Everything up to here can simply be orphaned if we abort
549
## the commit; it will leave junk files behind but that doesn't
550
## matter.
551
552
## TODO: Read back the just-generated changeset, and make sure it
553
## applies and recreates the right state.
554
555
## TODO: Also calculate and store the inventory SHA1
556
mutter("committing patch r%d" % (self.revno() + 1))
557
558
559
self.append_revision(rev_id)
560
561
if verbose:
562
note("commited r%d" % self.revno())
563
564
565
def append_revision(self, revision_id):
566
mutter("add {%s} to revision-history" % revision_id)
567
rev_history = self.revision_history()
568
569
tmprhname = self.controlfilename('revision-history.tmp')
570
rhname = self.controlfilename('revision-history')
571
572
f = file(tmprhname, 'wt')
573
rev_history.append(revision_id)
574
f.write('\n'.join(rev_history))
575
f.write('\n')
576
f.close()
577
578
if sys.platform == 'win32':
579
os.remove(rhname)
580
os.rename(tmprhname, rhname)
581
582
258
583
259
584
def get_revision(self, revision_id):
260
585
"""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)
270
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()
279
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')
586
r = Revision.read_xml(self.revision_store[revision_id])
587
assert r.revision_id == revision_id
588
return r
589
590
591
def get_inventory(self, inventory_id):
592
"""Get Inventory object by hash.
593
594
:todo: Perhaps for this and similar methods, take a revision
595
parameter which can be either an integer revno or a
596
string hash."""
597
i = Inventory.read_xml(self.inventory_store[inventory_id])
598
return i
599
307
600
308
601
def get_revision_inventory(self, revision_id):
309
602
"""Return inventory of a past revision."""
310
raise NotImplementedError('get_revision_inventory is abstract')
603
if revision_id == None:
604
return Inventory()
605
else:
606
return self.get_inventory(self.get_revision(revision_id).inventory_id)
607
311
608
312
609
def revision_history(self):
313
"""Return sequence of revision hashes on to this branch."""
314
raise NotImplementedError('revision_history is abstract')
610
"""Return sequence of revision hashes on to this branch.
611
612
>>> ScratchBranch().revision_history()
613
[]
614
"""
615
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
616
315
617
316
618
def revno(self):
317
619
"""Return current revision number for this branch.
318
620
319
621
That is equivalent to the number of revisions committed to
320
622
this branch.
623
624
>>> b = ScratchBranch()
625
>>> b.revno()
626
0
627
>>> b.commit('no foo')
628
>>> b.revno()
629
1
321
630
"""
322
631
return len(self.revision_history())
323
632
324
def last_revision(self):
325
"""Return last patch hash, or None if no history."""
633
634
def last_patch(self):
635
"""Return last patch hash, or None if no history.
636
637
>>> ScratchBranch().last_patch() == None
638
True
639
"""
326
640
ph = self.revision_history()
327
641
if ph:
328
642
return ph[-1]
329
643
else:
330
644
return None
331
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.
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."""
645
646
647
def lookup_revision(self, revno):
648
"""Return revision hash for revision number."""
396
649
if revno == 0:
397
650
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]
651
652
try:
653
# list is 0-based; revisions are 1-based
654
return self.revision_history()[revno-1]
655
except IndexError:
656
raise BzrError("no such revision %s" % revno)
657
403
658
404
659
def revision_tree(self, revision_id):
405
660
"""Return Tree for a revision on this branch.
406
661
407
662
`revision_id` may be None for the null revision, in which case
408
663
an `EmptyTree` is returned."""
409
raise NotImplementedError('revision_tree is abstract')
664
665
if revision_id == None:
666
return EmptyTree()
667
else:
668
inv = self.get_revision_inventory(revision_id)
669
return RevisionTree(self.text_store, inv)
670
410
671
411
672
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')
673
"""Return a `Tree` for the working copy."""
674
return WorkingTree(self.base, self.read_working_inventory())
414
675
415
def pull(self, source, overwrite=False):
416
raise NotImplementedError('pull is abstract')
417
676
418
677
def basis_tree(self):
419
678
"""Return `Tree` object for last revision.
420
679
421
680
If there are no revisions yet, return an `EmptyTree`.
681
682
>>> b = ScratchBranch(files=['foo'])
683
>>> b.basis_tree().has_filename('foo')
684
False
685
>>> b.working_tree().has_filename('foo')
686
True
687
>>> b.add('foo')
688
>>> b.commit('add foo')
689
>>> b.basis_tree().has_filename('foo')
690
True
422
691
"""
423
return self.revision_tree(self.last_revision())
692
r = self.last_patch()
693
if r == None:
694
return EmptyTree()
695
else:
696
return RevisionTree(self.text_store, self.get_revision_inventory(r))
697
698
699
700
def write_log(self, show_timezone='original'):
701
"""Write out human-readable log of commits to this branch
702
703
:param utc: If true, show dates in universal time, not local time."""
704
## TODO: Option to choose either original, utc or local timezone
705
revno = 1
706
precursor = None
707
for p in self.revision_history():
708
print '-' * 40
709
print 'revno:', revno
710
## TODO: Show hash if --id is given.
711
##print 'revision-hash:', p
712
rev = self.get_revision(p)
713
print 'committer:', rev.committer
714
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
715
show_timezone))
716
717
## opportunistic consistency check, same as check_patch_chaining
718
if rev.precursor != precursor:
719
bailout("mismatched precursor!")
720
721
print 'message:'
722
if not rev.message:
723
print ' (no message)'
724
else:
725
for l in rev.message.split('\n'):
726
print ' ' + l
727
728
revno += 1
729
precursor = p
730
424
731
425
732
def rename_one(self, from_rel, to_rel):
426
"""Rename one file.
427
428
This can change the directory or the filename or both.
429
"""
430
raise NotImplementedError('rename_one is abstract')
733
tree = self.working_tree()
734
inv = tree.inventory
735
if not tree.has_filename(from_rel):
736
bailout("can't rename: old working file %r does not exist" % from_rel)
737
if tree.has_filename(to_rel):
738
bailout("can't rename: new working file %r already exists" % to_rel)
739
740
file_id = inv.path2id(from_rel)
741
if file_id == None:
742
bailout("can't rename: old name %r is not versioned" % from_rel)
743
744
if inv.path2id(to_rel):
745
bailout("can't rename: new name %r is already versioned" % to_rel)
746
747
to_dir, to_tail = os.path.split(to_rel)
748
to_dir_id = inv.path2id(to_dir)
749
if to_dir_id == None and to_dir != '':
750
bailout("can't determine destination directory id for %r" % to_dir)
751
752
mutter("rename_one:")
753
mutter(" file_id {%s}" % file_id)
754
mutter(" from_rel %r" % from_rel)
755
mutter(" to_rel %r" % to_rel)
756
mutter(" to_dir %r" % to_dir)
757
mutter(" to_dir_id {%s}" % to_dir_id)
758
759
inv.rename(file_id, to_dir_id, to_tail)
760
761
print "%s => %s" % (from_rel, to_rel)
762
763
from_abs = self.abspath(from_rel)
764
to_abs = self.abspath(to_rel)
765
try:
766
os.rename(from_abs, to_abs)
767
except OSError, e:
768
bailout("failed to rename %r to %r: %s"
769
% (from_abs, to_abs, e[1]),
770
["rename rolled back"])
771
772
self._write_inventory(inv)
773
774
431
775
432
776
def move(self, from_paths, to_name):
433
777
"""Rename files.
439
783
440
784
Note that to_name is only the last component of the new name;
441
785
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('inventory-store')
589
self.text_store = get_store('text-store')
590
self.revision_store = get_store('revision-store')
591
elif self._branch_format == 5:
592
self.control_weaves = get_weave('')
593
self.weave_store = get_weave('weaves')
594
self.revision_store = get_store('revision-store', compressed=False)
595
elif self._branch_format == 6:
596
self.control_weaves = get_weave('')
597
self.weave_store = get_weave('weaves', prefixed=True)
598
self.revision_store = get_store('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 = '/'.join(file_or_path)
709
if file_or_path == '':
710
return bzrlib.BZRDIR
711
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + 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, revno):
828
"""See Branch.print_file."""
829
tree = self.revision_tree(self.get_rev_id(revno))
830
# use inventory as it was in that revision
831
file_id = tree.inventory.path2id(file)
832
if not file_id:
833
raise BzrError("%r is not present in revision %s" % (file, revno))
834
tree.print_file(file_id)
835
836
@needs_write_lock
837
def append_revision(self, *revision_ids):
838
"""See Branch.append_revision."""
839
for revision_id in revision_ids:
840
mutter("add {%s} to revision-history" % revision_id)
841
rev_history = self.revision_history()
842
rev_history.extend(revision_ids)
843
self.set_revision_history(rev_history)
844
845
@needs_write_lock
846
def set_revision_history(self, rev_history):
847
"""See Branch.set_revision_history."""
848
self.put_controlfile('revision-history', '\n'.join(rev_history))
849
850
def has_revision(self, revision_id):
851
"""See Branch.has_revision."""
852
return (revision_id is None
853
or self.revision_store.has_id(revision_id))
854
855
@needs_read_lock
856
def _get_revision_xml_file(self, revision_id):
857
if not revision_id or not isinstance(revision_id, basestring):
858
raise InvalidRevisionId(revision_id=revision_id, branch=self)
859
try:
860
return self.revision_store.get(revision_id)
861
except (IndexError, KeyError):
862
raise bzrlib.errors.NoSuchRevision(self, revision_id)
863
864
def get_revision_xml(self, revision_id):
865
"""See Branch.get_revision_xml."""
866
return self._get_revision_xml_file(revision_id).read()
867
868
def get_revision(self, revision_id):
869
"""See Branch.get_revision."""
870
xml_file = self._get_revision_xml_file(revision_id)
871
872
try:
873
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
874
except SyntaxError, e:
875
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
876
[revision_id,
877
str(e)])
878
879
assert r.revision_id == revision_id
880
return r
881
882
def get_revision_sha1(self, revision_id):
883
"""See Branch.get_revision_sha1."""
884
# In the future, revision entries will be signed. At that
885
# point, it is probably best *not* to include the signature
886
# in the revision hash. Because that lets you re-sign
887
# the revision, (add signatures/remove signatures) and still
888
# have all hash pointers stay consistent.
889
# But for now, just hash the contents.
890
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
891
892
def get_ancestry(self, revision_id):
893
"""See Branch.get_ancestry."""
894
if revision_id is None:
895
return [None]
896
w = self._get_inventory_weave()
897
return [None] + map(w.idx_to_name,
898
w.inclusions([w.lookup(revision_id)]))
899
900
def _get_inventory_weave(self):
901
return self.control_weaves.get_weave('inventory',
902
self.get_transaction())
903
904
def get_inventory(self, revision_id):
905
"""See Branch.get_inventory."""
906
xml = self.get_inventory_xml(revision_id)
907
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
908
909
def get_inventory_xml(self, revision_id):
910
"""See Branch.get_inventory_xml."""
911
try:
912
assert isinstance(revision_id, basestring), type(revision_id)
913
iw = self._get_inventory_weave()
914
return iw.get_text(iw.lookup(revision_id))
915
except IndexError:
916
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
917
918
def get_inventory_sha1(self, revision_id):
919
"""See Branch.get_inventory_sha1."""
920
return self.get_revision(revision_id).inventory_sha1
921
922
def get_revision_inventory(self, revision_id):
923
"""See Branch.get_revision_inventory."""
924
# TODO: Unify this with get_inventory()
925
# bzr 0.0.6 and later imposes the constraint that the inventory_id
926
# must be the same as its revision, so this is trivial.
927
if revision_id == None:
928
# This does not make sense: if there is no revision,
929
# then it is the current tree inventory surely ?!
930
# and thus get_root_id() is something that looks at the last
931
# commit on the branch, and the get_root_id is an inventory check.
932
raise NotImplementedError
933
# return Inventory(self.get_root_id())
934
else:
935
return self.get_inventory(revision_id)
936
937
@needs_read_lock
938
def revision_history(self):
939
"""See Branch.revision_history."""
940
transaction = self.get_transaction()
941
history = transaction.map.find_revision_history()
942
if history is not None:
943
mutter("cache hit for revision-history in %s", self)
944
return list(history)
945
history = [l.rstrip('\r\n') for l in
946
self.controlfile('revision-history', 'r').readlines()]
947
transaction.map.add_revision_history(history)
948
# this call is disabled because revision_history is
949
# not really an object yet, and the transaction is for objects.
950
# transaction.register_clean(history, precious=True)
951
return list(history)
952
953
def update_revisions(self, other, stop_revision=None):
954
"""See Branch.update_revisions."""
955
from bzrlib.fetch import greedy_fetch
956
if stop_revision is None:
957
stop_revision = other.last_revision()
958
### Should this be checking is_ancestor instead of revision_history?
959
if (stop_revision is not None and
960
stop_revision in self.revision_history()):
961
return
962
greedy_fetch(to_branch=self, from_branch=other,
963
revision=stop_revision)
964
pullable_revs = self.pullable_revisions(other, stop_revision)
965
if len(pullable_revs) > 0:
966
self.append_revision(*pullable_revs)
967
968
def pullable_revisions(self, other, stop_revision):
969
"""See Branch.pullable_revisions."""
970
other_revno = other.revision_id_to_revno(stop_revision)
971
try:
972
return self.missing_revisions(other, other_revno)
973
except DivergedBranches, e:
974
try:
975
pullable_revs = get_intervening_revisions(self.last_revision(),
976
stop_revision, self)
977
assert self.last_revision() not in pullable_revs
978
return pullable_revs
979
except bzrlib.errors.NotAncestor:
980
if is_ancestor(self.last_revision(), stop_revision, self):
981
return []
982
else:
983
raise e
984
985
def revision_tree(self, revision_id):
986
"""See Branch.revision_tree."""
987
# TODO: refactor this to use an existing revision object
988
# so we don't need to read it in twice.
989
if revision_id == None or revision_id == NULL_REVISION:
990
return EmptyTree()
991
else:
992
inv = self.get_revision_inventory(revision_id)
993
return RevisionTree(self.weave_store, inv, revision_id)
994
995
def working_tree(self):
996
"""See Branch.working_tree."""
997
from bzrlib.workingtree import WorkingTree
998
if self._transport.base.find('://') != -1:
999
raise NoWorkingTree(self.base)
1000
return WorkingTree(self.base, branch=self)
1001
1002
@needs_write_lock
1003
def pull(self, source, overwrite=False):
1004
"""See Branch.pull."""
1005
source.lock_read()
1006
try:
1007
old_count = len(self.revision_history())
1008
try:
1009
self.update_revisions(source)
1010
except DivergedBranches:
1011
if not overwrite:
1012
raise
1013
self.set_revision_history(source.revision_history())
1014
new_count = len(self.revision_history())
1015
return new_count - old_count
1016
finally:
1017
source.unlock()
1018
1019
def get_parent(self):
1020
"""See Branch.get_parent."""
1021
import errno
1022
_locs = ['parent', 'pull', 'x-pull']
1023
for l in _locs:
1024
try:
1025
return self.controlfile(l, 'r').read().strip('\n')
1026
except IOError, e:
1027
if e.errno != errno.ENOENT:
1028
raise
1029
return None
1030
1031
def get_push_location(self):
1032
"""See Branch.get_push_location."""
1033
config = bzrlib.config.BranchConfig(self)
1034
push_loc = config.get_user_option('push_location')
1035
return push_loc
1036
1037
def set_push_location(self, location):
1038
"""See Branch.set_push_location."""
1039
config = bzrlib.config.LocationConfig(self.base)
1040
config.set_user_option('push_location', location)
1041
1042
@needs_write_lock
1043
def set_parent(self, url):
1044
"""See Branch.set_parent."""
1045
# TODO: Maybe delete old location files?
1046
from bzrlib.atomicfile import AtomicFile
1047
f = AtomicFile(self.controlfilename('parent'))
1048
try:
1049
f.write(url + '\n')
1050
f.commit()
1051
finally:
1052
f.close()
1053
1054
def tree_config(self):
1055
return TreeConfig(self)
1056
1057
def sign_revision(self, revision_id, gpg_strategy):
1058
"""See Branch.sign_revision."""
1059
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1060
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1061
1062
@needs_write_lock
1063
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1064
"""See Branch.store_revision_signature."""
1065
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1066
revision_id, "sig")
1067
1068
1069
class ScratchBranch(BzrBranch):
786
"""
787
## TODO: Option to move IDs only
788
assert not isinstance(from_paths, basestring)
789
tree = self.working_tree()
790
inv = tree.inventory
791
to_abs = self.abspath(to_name)
792
if not isdir(to_abs):
793
bailout("destination %r is not a directory" % to_abs)
794
if not tree.has_filename(to_name):
795
bailout("destination %r not in working directory" % to_abs)
796
to_dir_id = inv.path2id(to_name)
797
if to_dir_id == None and to_name != '':
798
bailout("destination %r is not a versioned directory" % to_name)
799
to_dir_ie = inv[to_dir_id]
800
if to_dir_ie.kind not in ('directory', 'root_directory'):
801
bailout("destination %r is not a directory" % to_abs)
802
803
to_idpath = Set(inv.get_idpath(to_dir_id))
804
805
for f in from_paths:
806
if not tree.has_filename(f):
807
bailout("%r does not exist in working tree" % f)
808
f_id = inv.path2id(f)
809
if f_id == None:
810
bailout("%r is not versioned" % f)
811
name_tail = splitpath(f)[-1]
812
dest_path = appendpath(to_name, name_tail)
813
if tree.has_filename(dest_path):
814
bailout("destination %r already exists" % dest_path)
815
if f_id in to_idpath:
816
bailout("can't move %r to a subdirectory of itself" % f)
817
818
# OK, so there's a race here, it's possible that someone will
819
# create a file in this interval and then the rename might be
820
# left half-done. But we should have caught most problems.
821
822
for f in from_paths:
823
name_tail = splitpath(f)[-1]
824
dest_path = appendpath(to_name, name_tail)
825
print "%s => %s" % (f, dest_path)
826
inv.rename(inv.path2id(f), to_dir_id, name_tail)
827
try:
828
os.rename(self.abspath(f), self.abspath(dest_path))
829
except OSError, e:
830
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
831
["rename rolled back"])
832
833
self._write_inventory(inv)
834
835
836
837
def show_status(self, show_all=False):
838
"""Display single-line status for non-ignored working files.
839
840
The list is show sorted in order by file name.
841
842
>>> b = ScratchBranch(files=['foo', 'foo~'])
843
>>> b.show_status()
844
? foo
845
>>> b.add('foo')
846
>>> b.show_status()
847
A foo
848
>>> b.commit("add foo")
849
>>> b.show_status()
850
>>> os.unlink(b.abspath('foo'))
851
>>> b.show_status()
852
D foo
853
854
855
:todo: Get state for single files.
856
857
:todo: Perhaps show a slash at the end of directory names.
858
859
"""
860
861
# We have to build everything into a list first so that it can
862
# sorted by name, incorporating all the different sources.
863
864
# FIXME: Rather than getting things in random order and then sorting,
865
# just step through in order.
866
867
# Interesting case: the old ID for a file has been removed,
868
# but a new file has been created under that name.
869
870
old = self.basis_tree()
871
new = self.working_tree()
872
873
for fs, fid, oldname, newname, kind in diff_trees(old, new):
874
if fs == 'R':
875
show_status(fs, kind,
876
oldname + ' => ' + newname)
877
elif fs == 'A' or fs == 'M':
878
show_status(fs, kind, newname)
879
elif fs == 'D':
880
show_status(fs, kind, oldname)
881
elif fs == '.':
882
if show_all:
883
show_status(fs, kind, newname)
884
elif fs == 'I':
885
if show_all:
886
show_status(fs, kind, newname)
887
elif fs == '?':
888
show_status(fs, kind, newname)
889
else:
890
bailout("wierd file state %r" % ((fs, fid),))
891
892
893
894
class ScratchBranch(Branch):
1070
895
"""Special test class: a branch that cleans up after itself.
1071
896
1072
897
>>> b = ScratchBranch()
1073
898
>>> isdir(b.base)
1074
899
True
1075
900
>>> bd = b.base
1076
>>> b._transport.__del__()
901
>>> del b
1077
902
>>> isdir(bd)
1078
903
False
1079
904
"""
1080
1081
def __init__(self, files=[], dirs=[], transport=None):
905
def __init__(self, files=[], dirs=[]):
1082
906
"""Make a test branch.
1083
907
1084
908
This creates a temporary directory and runs init-tree in it.
1085
909
1086
910
If any files are listed, they are created in the working copy.
1087
911
"""
1088
if transport is None:
1089
transport = bzrlib.transport.local.ScratchTransport()
1090
super(ScratchBranch, self).__init__(transport, init=True)
1091
else:
1092
super(ScratchBranch, self).__init__(transport)
1093
912
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1094
913
for d in dirs:
1095
self._transport.mkdir(d)
914
os.mkdir(self.abspath(d))
1096
915
1097
916
for f in files:
1098
self._transport.put(f, 'content of %s' % f)
1099
1100
1101
def clone(self):
1102
"""
1103
>>> orig = ScratchBranch(files=["file1", "file2"])
1104
>>> clone = orig.clone()
1105
>>> if os.name != 'nt':
1106
... os.path.samefile(orig.base, clone.base)
1107
... else:
1108
... orig.base == clone.base
1109
...
1110
False
1111
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1112
True
1113
"""
1114
from shutil import copytree
1115
from tempfile import mkdtemp
1116
base = mkdtemp()
1117
os.rmdir(base)
1118
copytree(self.base, base, symlinks=True)
1119
return ScratchBranch(
1120
transport=bzrlib.transport.local.ScratchTransport(base))
917
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
918
919
920
def __del__(self):
921
"""Destroy the test branch, removing the scratch directory."""
922
try:
923
shutil.rmtree(self.base)
924
except OSError:
925
# Work around for shutil.rmtree failing on Windows when
926
# readonly files are encountered
927
for root, dirs, files in os.walk(self.base, topdown=False):
928
for name in files:
929
os.chmod(os.path.join(root, name), 0700)
930
shutil.rmtree(self.base)
931
1121
932
1122
933
1123
934
######################################################################
1136
947
break
1137
948
filename = head
1138
949
return False
950
951
952
953
def _gen_revision_id(when):
954
"""Return new revision-id."""
955
s = '%s-%s-' % (user_email(), compact_date(when))
956
s += hexlify(rand_bytes(8))
957
return s
958
959
960
def gen_file_id(name):
961
"""Return new file id.
962
963
This should probably generate proper UUIDs, but for the moment we
964
cope with just randomness because running uuidgen every time is
965
slow."""
966
idx = name.rfind('/')
967
if idx != -1:
968
name = name[idx+1 : ]
969
970
name = name.lstrip('.')
971
972
s = hexlify(rand_bytes(8))
973
return '-'.join((name, compact_date(time.time()), s))
974
975
Loggerhead is a web-based interface for Breezy
Version: 2.0.1