« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 254
- compare with another revision
- download diff
- download tarball
- view history from revision 254
- Committer: Martin Pool
- Date: 2005-04-15 01:31:21 UTC
- Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning
- files added:
- bzrlib/remotebranch.py
- files removed:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- 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 *
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 sys
19
import os
20
import errno
21
from warnings import warn
22
from cStringIO import StringIO
18
from sets import Set
23
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
24
23
25
24
import bzrlib
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
31
file_kind)
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)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision
39
from bzrlib.delta import compare_trees
40
from bzrlib.tree import EmptyTree, RevisionTree
41
from bzrlib.inventory import Inventory
42
from bzrlib.store import copy_all
43
from bzrlib.store.compressed_text import CompressedTextStore
44
from bzrlib.store.text import TextStore
45
from bzrlib.store.weave import WeaveStore
46
import bzrlib.transactions as transactions
47
from bzrlib.transport import Transport, get_transport
48
import bzrlib.xml5
49
import bzrlib.ui
50
51
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
54
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"
55
39
## TODO: Maybe include checks for common corruption of newlines, etc?
56
40
57
41
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations.
62
63
def find_branch(*ignored, **ignored_too):
64
# XXX: leave this here for about one release, then remove it
65
raise NotImplementedError('find_branch() is not supported anymore, '
66
'please use one of the new branch constructors')
67
def _relpath(base, path):
68
"""Return path relative to base, or raise exception.
69
70
The path may be either an absolute path or a path relative to the
71
current working directory.
72
73
Lifted out of Branch.relpath for ease of testing.
74
75
os.path.commonprefix (python2.4) has a bad bug that it works just
76
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
77
avoids that problem."""
78
rp = os.path.abspath(path)
79
80
s = []
81
head = rp
82
while len(head) >= len(base):
83
if head == base:
84
break
85
head, tail = os.path.split(head)
86
if tail:
87
s.insert(0, tail)
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)
88
54
else:
89
raise NotBranchError("path %r is not within branch %r" % (rp, base))
90
91
return os.sep.join(s)
92
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.
102
"""
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 _Branch(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 _Branch(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
"""
131
t = get_transport(url)
132
while True:
133
try:
134
return _Branch(t)
135
except NotBranchError:
136
pass
137
new_t = t.clone('..')
138
if new_t.base == t.base:
139
# reached the root, whatever that may be
140
raise NotBranchError('%s is not in a branch' % url)
141
t = new_t
142
143
@staticmethod
144
def initialize(base):
145
"""Create a new branch, rooted at 'base' (url)"""
146
t = get_transport(base)
147
return _Branch(t, init=True)
148
149
def setup_caching(self, cache_root):
150
"""Subclasses that care about caching should override this, and set
151
up cached stores located under cache_root.
152
"""
153
self.cache_root = cache_root
154
155
156
class _Branch(Branch):
157
"""A branch stored in the actual filesystem.
158
159
Note that it's "local" in the context of the filesystem; it doesn't
160
really matter if it's on an nfs/smb/afs/coda/... share, as long as
161
it's writable, and can be accessed via the normal filesystem API.
162
163
_lock_mode
164
None, or 'r' or 'w'
165
166
_lock_count
167
If _lock_mode is true, a positive count of the number of times the
168
lock has been taken.
169
170
_lock
171
Lock object from bzrlib.lock.
172
"""
173
# We actually expect this class to be somewhat short-lived; part of its
174
# purpose is to try to isolate what bits of the branch logic are tied to
175
# filesystem access, so that in a later step, we can extricate them to
176
# a separarte ("storage") class.
177
_lock_mode = None
178
_lock_count = None
179
_lock = None
180
_inventory_weave = None
181
182
# Map some sort of prefix into a namespace
183
# stuff like "revno:10", "revid:", etc.
184
# This should match a prefix with a function which accepts
185
REVISION_NAMESPACES = {}
186
187
def push_stores(self, branch_to):
188
"""Copy the content of this branches store to branch_to."""
189
if (self._branch_format != branch_to._branch_format
190
or self._branch_format != 4):
191
from bzrlib.fetch import greedy_fetch
192
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
193
self, self._branch_format, branch_to, branch_to._branch_format)
194
greedy_fetch(to_branch=branch_to, from_branch=self,
195
revision=self.last_revision())
196
return
197
198
store_pairs = ((self.text_store, branch_to.text_store),
199
(self.inventory_store, branch_to.inventory_store),
200
(self.revision_store, branch_to.revision_store))
201
try:
202
for from_store, to_store in store_pairs:
203
copy_all(from_store, to_store)
204
except UnlistableStore:
205
raise UnlistableBranch(from_store)
206
207
def __init__(self, transport, init=False,
208
relax_version_check=False):
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.
88
"""
89
def __init__(self, base, init=False, find_root=True):
209
90
"""Create new branch object at a particular location.
210
91
211
transport -- A Transport object, defining how to access files.
212
(If a string, transport.transport() will be used to
213
create a Transport object)
92
base -- Base directory for the branch.
214
93
215
94
init -- If True, create new control files in a previously
216
95
unversioned directory. If False, the branch must already
217
96
be versioned.
218
97
219
relax_version_check -- If true, the usual check for the branch
220
version is not applied. This is intended only for
221
upgrade/recovery type use; it's not guaranteed that
222
all operations will work on old format branches.
98
find_root -- If true and init is false, find the root of the
99
existing branch containing base.
223
100
224
101
In the test suite, creation of new trees is tested using the
225
102
`ScratchBranch` class.
226
103
"""
227
assert isinstance(transport, Transport), \
228
"%r is not a Transport" % transport
229
self._transport = transport
230
104
if init:
105
self.base = os.path.realpath(base)
231
106
self._make_control()
232
self._check_format(relax_version_check)
233
234
def get_store(name, compressed=True, prefixed=False):
235
# FIXME: This approach of assuming stores are all entirely compressed
236
# or entirely uncompressed is tidy, but breaks upgrade from
237
# some existing branches where there's a mixture; we probably
238
# still want the option to look for both.
239
relpath = self._rel_controlfilename(name)
240
if compressed:
241
store = CompressedTextStore(self._transport.clone(relpath),
242
prefixed=prefixed)
243
else:
244
store = TextStore(self._transport.clone(relpath),
245
prefixed=prefixed)
246
#if self._transport.should_cache():
247
# cache_path = os.path.join(self.cache_root, name)
248
# os.mkdir(cache_path)
249
# store = bzrlib.store.CachedStore(store, cache_path)
250
return store
251
def get_weave(name, prefixed=False):
252
relpath = self._rel_controlfilename(name)
253
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
254
if self._transport.should_cache():
255
ws.enable_cache = True
256
return ws
257
258
if self._branch_format == 4:
259
self.inventory_store = get_store('inventory-store')
260
self.text_store = get_store('text-store')
261
self.revision_store = get_store('revision-store')
262
elif self._branch_format == 5:
263
self.control_weaves = get_weave([])
264
self.weave_store = get_weave('weaves')
265
self.revision_store = get_store('revision-store', compressed=False)
266
elif self._branch_format == 6:
267
self.control_weaves = get_weave([])
268
self.weave_store = get_weave('weaves', prefixed=True)
269
self.revision_store = get_store('revision-store', compressed=False,
270
prefixed=True)
271
self._transaction = None
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
272
121
273
122
def __str__(self):
274
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
123
return '%s(%r)' % (self.__class__.__name__, self.base)
275
124
276
125
277
126
__repr__ = __str__
278
127
279
128
280
def __del__(self):
281
if self._lock_mode or self._lock:
282
# XXX: This should show something every time, and be suitable for
283
# headless operation and embedding
284
warn("branch %r was not explicitly unlocked" % self)
285
self._lock.unlock()
286
287
# TODO: It might be best to do this somewhere else,
288
# but it is nice for a Branch object to automatically
289
# cache it's information.
290
# Alternatively, we could have the Transport objects cache requests
291
# See the earlier discussion about how major objects (like Branch)
292
# should never expect their __del__ function to run.
293
if hasattr(self, 'cache_root') and self.cache_root is not None:
294
try:
295
import shutil
296
shutil.rmtree(self.cache_root)
297
except:
298
pass
299
self.cache_root = None
300
301
def _get_base(self):
302
if self._transport:
303
return self._transport.base
304
return None
305
306
base = property(_get_base)
307
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
312
self)
313
transaction = self._transaction
314
self._transaction = None
315
transaction.finish()
316
317
def get_transaction(self):
318
"""Return the current active transaction.
319
320
If no transaction is active, this returns a passthrough object
321
for which all data is immedaitely flushed and no caching happens.
322
"""
323
if self._transaction is None:
324
return transactions.PassThroughTransaction()
325
else:
326
return self._transaction
327
328
def _set_transaction(self, new_transaction):
329
"""Set a new active transaction."""
330
if self._transaction is not None:
331
raise errors.LockError('Branch %s is in a transaction already.' %
332
self)
333
self._transaction = new_transaction
334
335
def lock_write(self):
336
mutter("lock write: %s (%s)", self, self._lock_count)
337
# TODO: Upgrade locking to support using a Transport,
338
# and potentially a remote locking protocol
339
if self._lock_mode:
340
if self._lock_mode != 'w':
341
raise LockError("can't upgrade to a write lock from %r" %
342
self._lock_mode)
343
self._lock_count += 1
344
else:
345
self._lock = self._transport.lock_write(
346
self._rel_controlfilename('branch-lock'))
347
self._lock_mode = 'w'
348
self._lock_count = 1
349
self._set_transaction(transactions.PassThroughTransaction())
350
351
def lock_read(self):
352
mutter("lock read: %s (%s)", self, self._lock_count)
353
if self._lock_mode:
354
assert self._lock_mode in ('r', 'w'), \
355
"invalid lock mode %r" % self._lock_mode
356
self._lock_count += 1
357
else:
358
self._lock = self._transport.lock_read(
359
self._rel_controlfilename('branch-lock'))
360
self._lock_mode = 'r'
361
self._lock_count = 1
362
self._set_transaction(transactions.ReadOnlyTransaction())
363
# 5K may be excessive, but hey, its a knob.
364
self.get_transaction().set_cache_size(5000)
365
366
def unlock(self):
367
mutter("unlock: %s (%s)", self, self._lock_count)
368
if not self._lock_mode:
369
raise LockError('branch %r is not locked' % (self))
370
371
if self._lock_count > 1:
372
self._lock_count -= 1
373
else:
374
self._finish_transaction()
375
self._lock.unlock()
376
self._lock = None
377
self._lock_mode = self._lock_count = None
378
379
129
def abspath(self, name):
380
130
"""Return absolute filename for something in the branch"""
381
return self._transport.abspath(name)
131
return os.path.join(self.base, name)
132
382
133
383
134
def relpath(self, path):
384
135
"""Return path relative to this branch of something inside it.
385
136
386
137
Raises an error if path is not in this branch."""
387
return self._transport.relpath(path)
388
389
390
def _rel_controlfilename(self, file_or_path):
391
if isinstance(file_or_path, basestring):
392
file_or_path = [file_or_path]
393
return [bzrlib.BZRDIR] + file_or_path
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
394
146
395
147
def controlfilename(self, file_or_path):
396
148
"""Return location relative to branch."""
397
return self._transport.abspath(self._rel_controlfilename(file_or_path))
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)
398
152
399
153
400
154
def controlfile(self, file_or_path, mode='r'):
404
158
and binary. binary files are untranslated byte streams. Text
405
159
control files are stored with Unix newlines and in UTF-8, even
406
160
if the platform or locale defaults are different.
407
408
Controlfiles should almost never be opened in write mode but
409
rather should be atomically copied and replaced using atomicfile.
410
161
"""
411
import codecs
412
413
relpath = self._rel_controlfilename(file_or_path)
414
#TODO: codecs.open() buffers linewise, so it was overloaded with
415
# a much larger buffer, do we need to do the same for getreader/getwriter?
416
if mode == 'rb':
417
return self._transport.get(relpath)
418
elif mode == 'wb':
419
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
420
elif mode == 'r':
421
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
422
elif mode == 'w':
423
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
162
163
fn = self.controlfilename(file_or_path)
164
165
if mode == 'rb' or mode == 'wb':
166
return file(fn, mode)
167
elif mode == 'r' or mode == 'w':
168
# open in binary mode anyhow so there's no newline translation
169
import codecs
170
return codecs.open(fn, mode + 'b', 'utf-8')
424
171
else:
425
172
raise BzrError("invalid controlfile mode %r" % mode)
426
173
427
def put_controlfile(self, path, f, encode=True):
428
"""Write an entry as a controlfile.
429
430
:param path: The path to put the file, relative to the .bzr control
431
directory
432
:param f: A file-like or string object whose contents should be copied.
433
:param encode: If true, encode the contents as utf-8
434
"""
435
self.put_controlfiles([(path, f)], encode=encode)
436
437
def put_controlfiles(self, files, encode=True):
438
"""Write several entries as controlfiles.
439
440
:param files: A list of [(path, file)] pairs, where the path is the directory
441
underneath the bzr control directory
442
:param encode: If true, encode the contents as utf-8
443
"""
444
import codecs
445
ctrl_files = []
446
for path, f in files:
447
if encode:
448
if isinstance(f, basestring):
449
f = f.encode('utf-8', 'replace')
450
else:
451
f = codecs.getwriter('utf-8')(f, errors='replace')
452
path = self._rel_controlfilename(path)
453
ctrl_files.append((path, f))
454
self._transport.put_multi(ctrl_files)
174
455
175
456
176
def _make_control(self):
457
from bzrlib.inventory import Inventory
458
from bzrlib.weavefile import write_weave_v5
459
from bzrlib.weave import Weave
460
461
# Create an empty inventory
462
sio = StringIO()
463
# if we want per-tree root ids then this is the place to set
464
# them; they're not needed for now and so ommitted for
465
# simplicity.
466
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
467
empty_inv = sio.getvalue()
468
sio = StringIO()
469
bzrlib.weavefile.write_weave_v5(Weave(), sio)
470
empty_weave = sio.getvalue()
471
472
dirs = [[], 'revision-store', 'weaves']
473
files = [('README',
177
os.mkdir(self.controlfilename([]))
178
self.controlfile('README', 'w').write(
474
179
"This is a Bazaar-NG control directory.\n"
475
"Do not change any files in this directory.\n"),
476
('branch-format', BZR_BRANCH_FORMAT_6),
477
('revision-history', ''),
478
('branch-name', ''),
479
('branch-lock', ''),
480
('pending-merges', ''),
481
('inventory', empty_inv),
482
('inventory.weave', empty_weave),
483
('ancestry.weave', empty_weave)
484
]
485
cfn = self._rel_controlfilename
486
self._transport.mkdir_multi([cfn(d) for d in dirs])
487
self.put_controlfiles(files)
488
mutter('created control directory in ' + self._transport.base)
489
490
def _check_format(self, relax_version_check):
180
"Do not change any files in this directory.")
181
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
182
for d in ('text-store', 'inventory-store', 'revision-store'):
183
os.mkdir(self.controlfilename(d))
184
for f in ('revision-history', 'merged-patches',
185
'pending-merged-patches', 'branch-name'):
186
self.controlfile(f, 'w').write('')
187
mutter('created control directory in ' + self.base)
188
Inventory().write_xml(self.controlfile('inventory','w'))
189
190
191
def _check_format(self):
491
192
"""Check this branch format is supported.
492
193
493
The format level is stored, as an integer, in
494
self._branch_format for code that needs to check it later.
194
The current tool only supports the current unstable format.
495
195
496
196
In the future, we might need different in-memory Branch
497
197
classes to support downlevel branches. But not yet.
498
198
"""
499
try:
500
fmt = self.controlfile('branch-format', 'r').read()
501
except NoSuchFile:
502
raise NotBranchError(self.base)
503
mutter("got branch format %r", fmt)
504
if fmt == BZR_BRANCH_FORMAT_6:
505
self._branch_format = 6
506
elif fmt == BZR_BRANCH_FORMAT_5:
507
self._branch_format = 5
508
elif fmt == BZR_BRANCH_FORMAT_4:
509
self._branch_format = 4
510
511
if (not relax_version_check
512
and self._branch_format not in (5, 6)):
513
raise errors.UnsupportedFormatError(
514
'sorry, branch format %r not supported' % fmt,
515
['use a different bzr version',
516
'or remove the .bzr directory'
517
' and "bzr init" again'])
518
519
def get_root_id(self):
520
"""Return the id of this branches root"""
521
inv = self.read_working_inventory()
522
return inv.root.file_id
523
524
def set_root_id(self, file_id):
525
inv = self.read_working_inventory()
526
orig_root_id = inv.root.file_id
527
del inv._byid[inv.root.file_id]
528
inv.root.file_id = file_id
529
inv._byid[inv.root.file_id] = inv.root
530
for fid in inv:
531
entry = inv[fid]
532
if entry.parent_id in (None, orig_root_id):
533
entry.parent_id = inv.root.file_id
534
self._write_inventory(inv)
199
# This ignores newlines so that we can open branches created
200
# on Windows from Linux and so on. I think it might be better
201
# to always make all internal files in unix format.
202
fmt = self.controlfile('branch-format', 'r').read()
203
fmt.replace('\r\n', '')
204
if fmt != BZR_BRANCH_FORMAT:
205
bailout('sorry, branch format %r not supported' % fmt,
206
['use a different bzr version',
207
'or remove the .bzr directory and "bzr init" again'])
208
535
209
536
210
def read_working_inventory(self):
537
211
"""Read the working inventory."""
538
self.lock_read()
539
try:
540
# ElementTree does its own conversion from UTF-8, so open in
541
# binary.
542
f = self.controlfile('inventory', 'rb')
543
return bzrlib.xml5.serializer_v5.read_inventory(f)
544
finally:
545
self.unlock()
546
212
before = time.time()
213
# ElementTree does its own conversion from UTF-8, so open in
214
# binary.
215
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
216
mutter("loaded inventory of %d items in %f"
217
% (len(inv), time.time() - before))
218
return inv
219
547
220
548
221
def _write_inventory(self, inv):
549
222
"""Update the working inventory.
551
224
That is to say, the inventory describing changes underway, that
552
225
will be committed to the next revision.
553
226
"""
554
from cStringIO import StringIO
555
self.lock_write()
556
try:
557
sio = StringIO()
558
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
559
sio.seek(0)
560
# Transport handles atomicity
561
self.put_controlfile('inventory', sio)
562
finally:
563
self.unlock()
564
227
## TODO: factor out to atomicfile? is rename safe on windows?
228
## TODO: Maybe some kind of clean/dirty marker on inventory?
229
tmpfname = self.controlfilename('inventory.tmp')
230
tmpf = file(tmpfname, 'wb')
231
inv.write_xml(tmpf)
232
tmpf.close()
233
inv_fname = self.controlfilename('inventory')
234
if sys.platform == 'win32':
235
os.remove(inv_fname)
236
os.rename(tmpfname, inv_fname)
565
237
mutter('wrote working inventory')
566
238
239
567
240
inventory = property(read_working_inventory, _write_inventory, None,
568
241
"""Inventory for the working copy.""")
569
242
570
def add(self, files, ids=None):
243
244
def add(self, files, verbose=False):
571
245
"""Make files versioned.
572
246
573
Note that the command line normally calls smart_add instead,
574
which can automatically recurse.
247
Note that the command line normally calls smart_add instead.
575
248
576
249
This puts the files in the Added state, so that they will be
577
250
recorded by the next commit.
578
251
579
files
580
List of paths to add, relative to the base of the tree.
581
582
ids
583
If set, use these instead of automatically generated ids.
584
Must be the same length as the list of files, but may
585
contain None for ids that are to be autogenerated.
586
587
252
TODO: Perhaps have an option to add the ids even if the files do
588
not (yet) exist.
589
590
TODO: Perhaps yield the ids and paths as they're added.
253
not (yet) exist.
254
255
TODO: Perhaps return the ids of the files? But then again it
256
is easy to retrieve them if they're needed.
257
258
TODO: Option to specify file id.
259
260
TODO: Adding a directory should optionally recurse down and
261
add all non-ignored children. Perhaps do that in a
262
higher-level method.
263
264
>>> b = ScratchBranch(files=['foo'])
265
>>> 'foo' in b.unknowns()
266
True
267
>>> b.show_status()
268
? foo
269
>>> b.add('foo')
270
>>> 'foo' in b.unknowns()
271
False
272
>>> bool(b.inventory.path2id('foo'))
273
True
274
>>> b.show_status()
275
A foo
276
277
>>> b.add('foo')
278
Traceback (most recent call last):
279
...
280
BzrError: ('foo is already versioned', [])
281
282
>>> b.add(['nothere'])
283
Traceback (most recent call last):
284
BzrError: ('cannot add: not a regular file or directory: nothere', [])
591
285
"""
286
592
287
# TODO: Re-adding a file that is removed in the working copy
593
288
# should probably put it back with the previous ID.
594
if isinstance(files, basestring):
595
assert(ids is None or isinstance(ids, basestring))
289
if isinstance(files, types.StringTypes):
596
290
files = [files]
597
if ids is not None:
598
ids = [ids]
599
600
if ids is None:
601
ids = [None] * len(files)
602
else:
603
assert(len(ids) == len(files))
604
605
self.lock_write()
606
try:
607
inv = self.read_working_inventory()
608
for f,file_id in zip(files, ids):
609
if is_control_file(f):
610
raise BzrError("cannot add control file %s" % quotefn(f))
611
612
fp = splitpath(f)
613
614
if len(fp) == 0:
615
raise BzrError("cannot add top-level %r" % f)
616
617
fullpath = os.path.normpath(self.abspath(f))
618
619
try:
620
kind = file_kind(fullpath)
621
except OSError:
622
# maybe something better?
623
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
624
625
if not InventoryEntry.versionable_kind(kind):
626
raise BzrError('cannot add: not a versionable file ('
627
'i.e. regular file, symlink or directory): %s' % quotefn(f))
628
629
if file_id is None:
630
file_id = gen_file_id(f)
631
inv.add_path(f, kind=kind, file_id=file_id)
632
633
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
634
635
self._write_inventory(inv)
636
finally:
637
self.unlock()
638
291
292
inv = self.read_working_inventory()
293
for f in files:
294
if is_control_file(f):
295
bailout("cannot add control file %s" % quotefn(f))
296
297
fp = splitpath(f)
298
299
if len(fp) == 0:
300
bailout("cannot add top-level %r" % f)
301
302
fullpath = os.path.normpath(self.abspath(f))
303
304
try:
305
kind = file_kind(fullpath)
306
except OSError:
307
# maybe something better?
308
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
309
310
if kind != 'file' and kind != 'directory':
311
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
312
313
file_id = gen_file_id(f)
314
inv.add_path(f, kind=kind, file_id=file_id)
315
316
if verbose:
317
show_status('A', kind, quotefn(f))
318
319
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
320
321
self._write_inventory(inv)
322
639
323
640
324
def print_file(self, file, revno):
641
325
"""Print `file` to stdout."""
642
self.lock_read()
643
try:
644
tree = self.revision_tree(self.get_rev_id(revno))
645
# use inventory as it was in that revision
646
file_id = tree.inventory.path2id(file)
647
if not file_id:
648
raise BzrError("%r is not present in revision %s" % (file, revno))
649
tree.print_file(file_id)
650
finally:
651
self.unlock()
652
326
tree = self.revision_tree(self.lookup_revision(revno))
327
# use inventory as it was in that revision
328
file_id = tree.inventory.path2id(file)
329
if not file_id:
330
bailout("%r is not present in revision %d" % (file, revno))
331
tree.print_file(file_id)
332
653
333
654
334
def remove(self, files, verbose=False):
655
335
"""Mark nominated files for removal from the inventory.
658
338
659
339
TODO: Refuse to remove modified files unless --force is given?
660
340
341
>>> b = ScratchBranch(files=['foo'])
342
>>> b.add('foo')
343
>>> b.inventory.has_filename('foo')
344
True
345
>>> b.remove('foo')
346
>>> b.working_tree().has_filename('foo')
347
True
348
>>> b.inventory.has_filename('foo')
349
False
350
351
>>> b = ScratchBranch(files=['foo'])
352
>>> b.add('foo')
353
>>> b.commit('one')
354
>>> b.remove('foo')
355
>>> b.commit('two')
356
>>> b.inventory.has_filename('foo')
357
False
358
>>> b.basis_tree().has_filename('foo')
359
False
360
>>> b.working_tree().has_filename('foo')
361
True
362
661
363
TODO: Do something useful with directories.
662
364
663
365
TODO: Should this remove the text or not? Tough call; not
667
369
"""
668
370
## TODO: Normalize names
669
371
## TODO: Remove nested loops; better scalability
670
if isinstance(files, basestring):
372
373
if isinstance(files, types.StringTypes):
671
374
files = [files]
672
673
self.lock_write()
674
675
try:
676
tree = self.working_tree()
677
inv = tree.inventory
678
679
# do this before any modifications
680
for f in files:
681
fid = inv.path2id(f)
682
if not fid:
683
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
684
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
685
if verbose:
686
# having remove it, it must be either ignored or unknown
687
if tree.is_ignored(f):
688
new_status = 'I'
689
else:
690
new_status = '?'
691
show_status(new_status, inv[fid].kind, quotefn(f))
692
del inv[fid]
693
694
self._write_inventory(inv)
695
finally:
696
self.unlock()
697
698
# FIXME: this doesn't need to be a branch method
699
def set_inventory(self, new_inventory_list):
700
from bzrlib.inventory import Inventory, InventoryEntry
701
inv = Inventory(self.get_root_id())
702
for path, file_id, parent, kind in new_inventory_list:
703
name = os.path.basename(path)
704
if name == "":
705
continue
706
# fixme, there should be a factory function inv,add_??
707
if kind == 'directory':
708
inv.add(inventory.InventoryDirectory(file_id, name, parent))
709
elif kind == 'file':
710
inv.add(inventory.InventoryFile(file_id, name, parent))
711
elif kind == 'symlink':
712
inv.add(inventory.InventoryLink(file_id, name, parent))
713
else:
714
raise BzrError("unknown kind %r" % kind)
375
376
tree = self.working_tree()
377
inv = tree.inventory
378
379
# do this before any modifications
380
for f in files:
381
fid = inv.path2id(f)
382
if not fid:
383
bailout("cannot remove unversioned file %s" % quotefn(f))
384
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
385
if verbose:
386
# having remove it, it must be either ignored or unknown
387
if tree.is_ignored(f):
388
new_status = 'I'
389
else:
390
new_status = '?'
391
show_status(new_status, inv[fid].kind, quotefn(f))
392
del inv[fid]
393
715
394
self._write_inventory(inv)
716
395
396
717
397
def unknowns(self):
718
398
"""Return all unknown files.
719
399
733
413
return self.working_tree().unknowns()
734
414
735
415
736
def append_revision(self, *revision_ids):
737
for revision_id in revision_ids:
738
mutter("add {%s} to revision-history" % revision_id)
739
self.lock_write()
740
try:
741
rev_history = self.revision_history()
742
rev_history.extend(revision_ids)
743
self.put_controlfile('revision-history', '\n'.join(rev_history))
744
finally:
745
self.unlock()
746
747
def has_revision(self, revision_id):
748
"""True if this branch has a copy of the revision.
749
750
This does not necessarily imply the revision is merge
751
or on the mainline."""
752
return (revision_id is None
753
or revision_id in self.revision_store)
754
755
def get_revision_xml_file(self, revision_id):
756
"""Return XML file object for revision object."""
757
if not revision_id or not isinstance(revision_id, basestring):
758
raise InvalidRevisionId(revision_id)
759
760
self.lock_read()
761
try:
762
try:
763
return self.revision_store[revision_id]
764
except (IndexError, KeyError):
765
raise bzrlib.errors.NoSuchRevision(self, revision_id)
766
finally:
767
self.unlock()
768
769
#deprecated
770
get_revision_xml = get_revision_xml_file
771
772
def get_revision_xml(self, revision_id):
773
return self.get_revision_xml_file(revision_id).read()
416
def commit(self, message, timestamp=None, timezone=None,
417
committer=None,
418
verbose=False):
419
"""Commit working copy as a new revision.
420
421
The basic approach is to add all the file texts into the
422
store, then the inventory, then make a new revision pointing
423
to that inventory and store that.
424
425
This is not quite safe if the working copy changes during the
426
commit; for the moment that is simply not allowed. A better
427
approach is to make a temporary copy of the files before
428
computing their hashes, and then add those hashes in turn to
429
the inventory. This should mean at least that there are no
430
broken hash pointers. There is no way we can get a snapshot
431
of the whole directory at an instant. This would also have to
432
be robust against files disappearing, moving, etc. So the
433
whole thing is a bit hard.
434
435
timestamp -- if not None, seconds-since-epoch for a
436
postdated/predated commit.
437
"""
438
439
## TODO: Show branch names
440
441
# TODO: Don't commit if there are no changes, unless forced?
442
443
# First walk over the working inventory; and both update that
444
# and also build a new revision inventory. The revision
445
# inventory needs to hold the text-id, sha1 and size of the
446
# actual file versions committed in the revision. (These are
447
# not present in the working inventory.) We also need to
448
# detect missing/deleted files, and remove them from the
449
# working inventory.
450
451
work_inv = self.read_working_inventory()
452
inv = Inventory()
453
basis = self.basis_tree()
454
basis_inv = basis.inventory
455
missing_ids = []
456
for path, entry in work_inv.iter_entries():
457
## TODO: Cope with files that have gone missing.
458
459
## TODO: Check that the file kind has not changed from the previous
460
## revision of this file (if any).
461
462
entry = entry.copy()
463
464
p = self.abspath(path)
465
file_id = entry.file_id
466
mutter('commit prep file %s, id %r ' % (p, file_id))
467
468
if not os.path.exists(p):
469
mutter(" file is missing, removing from inventory")
470
if verbose:
471
show_status('D', entry.kind, quotefn(path))
472
missing_ids.append(file_id)
473
continue
474
475
# TODO: Handle files that have been deleted
476
477
# TODO: Maybe a special case for empty files? Seems a
478
# waste to store them many times.
479
480
inv.add(entry)
481
482
if basis_inv.has_id(file_id):
483
old_kind = basis_inv[file_id].kind
484
if old_kind != entry.kind:
485
bailout("entry %r changed kind from %r to %r"
486
% (file_id, old_kind, entry.kind))
487
488
if entry.kind == 'directory':
489
if not isdir(p):
490
bailout("%s is entered as directory but not a directory" % quotefn(p))
491
elif entry.kind == 'file':
492
if not isfile(p):
493
bailout("%s is entered as file but is not a file" % quotefn(p))
494
495
content = file(p, 'rb').read()
496
497
entry.text_sha1 = sha_string(content)
498
entry.text_size = len(content)
499
500
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
501
if (old_ie
502
and (old_ie.text_size == entry.text_size)
503
and (old_ie.text_sha1 == entry.text_sha1)):
504
## assert content == basis.get_file(file_id).read()
505
entry.text_id = basis_inv[file_id].text_id
506
mutter(' unchanged from previous text_id {%s}' %
507
entry.text_id)
508
509
else:
510
entry.text_id = gen_file_id(entry.name)
511
self.text_store.add(content, entry.text_id)
512
mutter(' stored with text_id {%s}' % entry.text_id)
513
if verbose:
514
if not old_ie:
515
state = 'A'
516
elif (old_ie.name == entry.name
517
and old_ie.parent_id == entry.parent_id):
518
state = 'M'
519
else:
520
state = 'R'
521
522
show_status(state, entry.kind, quotefn(path))
523
524
for file_id in missing_ids:
525
# have to do this later so we don't mess up the iterator.
526
# since parents may be removed before their children we
527
# have to test.
528
529
# FIXME: There's probably a better way to do this; perhaps
530
# the workingtree should know how to filter itself.
531
if work_inv.has_id(file_id):
532
del work_inv[file_id]
533
534
535
inv_id = rev_id = _gen_revision_id(time.time())
536
537
inv_tmp = tempfile.TemporaryFile()
538
inv.write_xml(inv_tmp)
539
inv_tmp.seek(0)
540
self.inventory_store.add(inv_tmp, inv_id)
541
mutter('new inventory_id is {%s}' % inv_id)
542
543
self._write_inventory(work_inv)
544
545
if timestamp == None:
546
timestamp = time.time()
547
548
if committer == None:
549
committer = username()
550
551
if timezone == None:
552
timezone = local_time_offset()
553
554
mutter("building commit log message")
555
rev = Revision(timestamp=timestamp,
556
timezone=timezone,
557
committer=committer,
558
precursor = self.last_patch(),
559
message = message,
560
inventory_id=inv_id,
561
revision_id=rev_id)
562
563
rev_tmp = tempfile.TemporaryFile()
564
rev.write_xml(rev_tmp)
565
rev_tmp.seek(0)
566
self.revision_store.add(rev_tmp, rev_id)
567
mutter("new revision_id is {%s}" % rev_id)
568
569
## XXX: Everything up to here can simply be orphaned if we abort
570
## the commit; it will leave junk files behind but that doesn't
571
## matter.
572
573
## TODO: Read back the just-generated changeset, and make sure it
574
## applies and recreates the right state.
575
576
## TODO: Also calculate and store the inventory SHA1
577
mutter("committing patch r%d" % (self.revno() + 1))
578
579
580
self.append_revision(rev_id)
581
582
if verbose:
583
note("commited r%d" % self.revno())
584
585
586
def append_revision(self, revision_id):
587
mutter("add {%s} to revision-history" % revision_id)
588
rev_history = self.revision_history()
589
590
tmprhname = self.controlfilename('revision-history.tmp')
591
rhname = self.controlfilename('revision-history')
592
593
f = file(tmprhname, 'wt')
594
rev_history.append(revision_id)
595
f.write('\n'.join(rev_history))
596
f.write('\n')
597
f.close()
598
599
if sys.platform == 'win32':
600
os.remove(rhname)
601
os.rename(tmprhname, rhname)
602
774
603
775
604
776
605
def get_revision(self, revision_id):
777
606
"""Return the Revision object for a named revision"""
778
xml_file = self.get_revision_xml_file(revision_id)
779
780
try:
781
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
782
except SyntaxError, e:
783
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
784
[revision_id,
785
str(e)])
786
607
r = Revision.read_xml(self.revision_store[revision_id])
787
608
assert r.revision_id == revision_id
788
609
return r
789
610
790
def get_revision_delta(self, revno):
791
"""Return the delta for one revision.
792
793
The delta is relative to its mainline predecessor, or the
794
empty tree for revision 1.
795
"""
796
assert isinstance(revno, int)
797
rh = self.revision_history()
798
if not (1 <= revno <= len(rh)):
799
raise InvalidRevisionNumber(revno)
800
801
# revno is 1-based; list is 0-based
802
803
new_tree = self.revision_tree(rh[revno-1])
804
if revno == 1:
805
old_tree = EmptyTree()
806
else:
807
old_tree = self.revision_tree(rh[revno-2])
808
809
return compare_trees(old_tree, new_tree)
810
811
def get_revision_sha1(self, revision_id):
812
"""Hash the stored value of a revision, and return it."""
813
# In the future, revision entries will be signed. At that
814
# point, it is probably best *not* to include the signature
815
# in the revision hash. Because that lets you re-sign
816
# the revision, (add signatures/remove signatures) and still
817
# have all hash pointers stay consistent.
818
# But for now, just hash the contents.
819
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
820
821
def get_ancestry(self, revision_id):
822
"""Return a list of revision-ids integrated by a revision.
823
824
This currently returns a list, but the ordering is not guaranteed:
825
treat it as a set.
826
"""
827
if revision_id is None:
828
return [None]
829
w = self.get_inventory_weave()
830
return [None] + map(w.idx_to_name,
831
w.inclusions([w.lookup(revision_id)]))
832
833
def get_inventory_weave(self):
834
return self.control_weaves.get_weave('inventory',
835
self.get_transaction())
836
837
def get_inventory(self, revision_id):
838
"""Get Inventory object by hash."""
839
xml = self.get_inventory_xml(revision_id)
840
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
841
842
def get_inventory_xml(self, revision_id):
843
"""Get inventory XML as a file object."""
844
try:
845
assert isinstance(revision_id, basestring), type(revision_id)
846
iw = self.get_inventory_weave()
847
return iw.get_text(iw.lookup(revision_id))
848
except IndexError:
849
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
850
851
def get_inventory_sha1(self, revision_id):
852
"""Return the sha1 hash of the inventory entry
853
"""
854
return self.get_revision(revision_id).inventory_sha1
611
612
def get_inventory(self, inventory_id):
613
"""Get Inventory object by hash.
614
615
TODO: Perhaps for this and similar methods, take a revision
616
parameter which can be either an integer revno or a
617
string hash."""
618
i = Inventory.read_xml(self.inventory_store[inventory_id])
619
return i
620
855
621
856
622
def get_revision_inventory(self, revision_id):
857
623
"""Return inventory of a past revision."""
858
# TODO: Unify this with get_inventory()
859
# bzr 0.0.6 and later imposes the constraint that the inventory_id
860
# must be the same as its revision, so this is trivial.
861
624
if revision_id == None:
862
return Inventory(self.get_root_id())
625
return Inventory()
863
626
else:
864
return self.get_inventory(revision_id)
627
return self.get_inventory(self.get_revision(revision_id).inventory_id)
628
865
629
866
630
def revision_history(self):
867
"""Return sequence of revision hashes on to this branch."""
868
self.lock_read()
869
try:
870
transaction = self.get_transaction()
871
history = transaction.map.find_revision_history()
872
if history is not None:
873
mutter("cache hit for revision-history in %s", self)
874
return list(history)
875
history = [l.rstrip('\r\n') for l in
876
self.controlfile('revision-history', 'r').readlines()]
877
transaction.map.add_revision_history(history)
878
# this call is disabled because revision_history is
879
# not really an object yet, and the transaction is for objects.
880
# transaction.register_clean(history, precious=True)
881
return list(history)
882
finally:
883
self.unlock()
631
"""Return sequence of revision hashes on to this branch.
884
632
885
def common_ancestor(self, other, self_revno=None, other_revno=None):
886
"""
887
>>> from bzrlib.commit import commit
888
>>> sb = ScratchBranch(files=['foo', 'foo~'])
889
>>> sb.common_ancestor(sb) == (None, None)
890
True
891
>>> commit(sb, "Committing first revision", verbose=False)
892
>>> sb.common_ancestor(sb)[0]
893
1
894
>>> clone = sb.clone()
895
>>> commit(sb, "Committing second revision", verbose=False)
896
>>> sb.common_ancestor(sb)[0]
897
2
898
>>> sb.common_ancestor(clone)[0]
899
1
900
>>> commit(clone, "Committing divergent second revision",
901
... verbose=False)
902
>>> sb.common_ancestor(clone)[0]
903
1
904
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
905
True
906
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
907
True
908
>>> clone2 = sb.clone()
909
>>> sb.common_ancestor(clone2)[0]
910
2
911
>>> sb.common_ancestor(clone2, self_revno=1)[0]
912
1
913
>>> sb.common_ancestor(clone2, other_revno=1)[0]
914
1
915
"""
916
my_history = self.revision_history()
917
other_history = other.revision_history()
918
if self_revno is None:
919
self_revno = len(my_history)
920
if other_revno is None:
921
other_revno = len(other_history)
922
indices = range(min((self_revno, other_revno)))
923
indices.reverse()
924
for r in indices:
925
if my_history[r] == other_history[r]:
926
return r+1, my_history[r]
927
return None, None
633
>>> ScratchBranch().revision_history()
634
[]
635
"""
636
return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]
928
637
929
638
930
639
def revno(self):
932
641
933
642
That is equivalent to the number of revisions committed to
934
643
this branch.
644
645
>>> b = ScratchBranch()
646
>>> b.revno()
647
0
648
>>> b.commit('no foo')
649
>>> b.revno()
650
1
935
651
"""
936
652
return len(self.revision_history())
937
653
938
654
939
def last_revision(self):
655
def last_patch(self):
940
656
"""Return last patch hash, or None if no history.
657
658
>>> ScratchBranch().last_patch() == None
659
True
941
660
"""
942
661
ph = self.revision_history()
943
662
if ph:
944
663
return ph[-1]
945
664
else:
946
665
return None
947
948
949
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
950
"""Return a list of new revisions that would perfectly fit.
951
666
952
If self and other have not diverged, return a list of the revisions
953
present in other, but missing from self.
954
955
>>> from bzrlib.commit import commit
956
>>> bzrlib.trace.silent = True
957
>>> br1 = ScratchBranch()
958
>>> br2 = ScratchBranch()
959
>>> br1.missing_revisions(br2)
960
[]
961
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
962
>>> br1.missing_revisions(br2)
963
[u'REVISION-ID-1']
964
>>> br2.missing_revisions(br1)
965
[]
966
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
967
>>> br1.missing_revisions(br2)
968
[]
969
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
970
>>> br1.missing_revisions(br2)
971
[u'REVISION-ID-2A']
972
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
973
>>> br1.missing_revisions(br2)
974
Traceback (most recent call last):
975
DivergedBranches: These branches have diverged.
976
"""
977
# FIXME: If the branches have diverged, but the latest
978
# revision in this branch is completely merged into the other,
979
# then we should still be able to pull.
980
self_history = self.revision_history()
981
self_len = len(self_history)
982
other_history = other.revision_history()
983
other_len = len(other_history)
984
common_index = min(self_len, other_len) -1
985
if common_index >= 0 and \
986
self_history[common_index] != other_history[common_index]:
987
raise DivergedBranches(self, other)
988
989
if stop_revision is None:
990
stop_revision = other_len
991
else:
992
assert isinstance(stop_revision, int)
993
if stop_revision > other_len:
994
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
995
return other_history[self_len:stop_revision]
996
997
def update_revisions(self, other, stop_revision=None):
998
"""Pull in new perfect-fit revisions."""
999
from bzrlib.fetch import greedy_fetch
1000
from bzrlib.revision import get_intervening_revisions
1001
if stop_revision is None:
1002
stop_revision = other.last_revision()
1003
if (stop_revision is not None and
1004
stop_revision in self.revision_history()):
1005
return
1006
greedy_fetch(to_branch=self, from_branch=other,
1007
revision=stop_revision)
1008
pullable_revs = self.missing_revisions(
1009
other, other.revision_id_to_revno(stop_revision))
1010
if pullable_revs:
1011
greedy_fetch(to_branch=self,
1012
from_branch=other,
1013
revision=pullable_revs[-1])
1014
self.append_revision(*pullable_revs)
1015
1016
1017
def commit(self, *args, **kw):
1018
from bzrlib.commit import Commit
1019
Commit().commit(self, *args, **kw)
1020
1021
def revision_id_to_revno(self, revision_id):
1022
"""Given a revision id, return its revno"""
1023
if revision_id is None:
1024
return 0
1025
history = self.revision_history()
1026
try:
1027
return history.index(revision_id) + 1
1028
except ValueError:
1029
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1030
1031
def get_rev_id(self, revno, history=None):
1032
"""Find the revision id of the specified revno."""
667
668
def lookup_revision(self, revno):
669
"""Return revision hash for revision number."""
1033
670
if revno == 0:
1034
671
return None
1035
if history is None:
1036
history = self.revision_history()
1037
elif revno <= 0 or revno > len(history):
1038
raise bzrlib.errors.NoSuchRevision(self, revno)
1039
return history[revno - 1]
672
673
try:
674
# list is 0-based; revisions are 1-based
675
return self.revision_history()[revno-1]
676
except IndexError:
677
raise BzrError("no such revision %s" % revno)
678
1040
679
1041
680
def revision_tree(self, revision_id):
1042
681
"""Return Tree for a revision on this branch.
1043
682
1044
683
`revision_id` may be None for the null revision, in which case
1045
684
an `EmptyTree` is returned."""
1046
# TODO: refactor this to use an existing revision object
1047
# so we don't need to read it in twice.
685
1048
686
if revision_id == None:
1049
687
return EmptyTree()
1050
688
else:
1051
689
inv = self.get_revision_inventory(revision_id)
1052
return RevisionTree(self.weave_store, inv, revision_id)
690
return RevisionTree(self.text_store, inv)
1053
691
1054
692
1055
693
def working_tree(self):
1056
694
"""Return a `Tree` for the working copy."""
1057
from bzrlib.workingtree import WorkingTree
1058
# TODO: In the future, WorkingTree should utilize Transport
1059
# RobertCollins 20051003 - I don't think it should - working trees are
1060
# much more complex to keep consistent than our careful .bzr subset.
1061
# instead, we should say that working trees are local only, and optimise
1062
# for that.
1063
return WorkingTree(self._transport.base, self.read_working_inventory())
695
return WorkingTree(self.base, self.read_working_inventory())
1064
696
1065
697
1066
698
def basis_tree(self):
1067
699
"""Return `Tree` object for last revision.
1068
700
1069
701
If there are no revisions yet, return an `EmptyTree`.
702
703
>>> b = ScratchBranch(files=['foo'])
704
>>> b.basis_tree().has_filename('foo')
705
False
706
>>> b.working_tree().has_filename('foo')
707
True
708
>>> b.add('foo')
709
>>> b.commit('add foo')
710
>>> b.basis_tree().has_filename('foo')
711
True
1070
712
"""
1071
return self.revision_tree(self.last_revision())
713
r = self.last_patch()
714
if r == None:
715
return EmptyTree()
716
else:
717
return RevisionTree(self.text_store, self.get_revision_inventory(r))
718
719
720
721
def write_log(self, show_timezone='original', verbose=False):
722
"""Write out human-readable log of commits to this branch
723
724
utc -- If true, show dates in universal time, not local time."""
725
## TODO: Option to choose either original, utc or local timezone
726
revno = 1
727
precursor = None
728
for p in self.revision_history():
729
print '-' * 40
730
print 'revno:', revno
731
## TODO: Show hash if --id is given.
732
##print 'revision-hash:', p
733
rev = self.get_revision(p)
734
print 'committer:', rev.committer
735
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
736
show_timezone))
737
738
## opportunistic consistency check, same as check_patch_chaining
739
if rev.precursor != precursor:
740
bailout("mismatched precursor!")
741
742
print 'message:'
743
if not rev.message:
744
print ' (no message)'
745
else:
746
for l in rev.message.split('\n'):
747
print ' ' + l
748
749
if verbose == True and precursor != None:
750
print 'changed files:'
751
tree = self.revision_tree(p)
752
prevtree = self.revision_tree(precursor)
753
754
for file_state, fid, old_name, new_name, kind in \
755
diff_trees(prevtree, tree, ):
756
if file_state == 'A' or file_state == 'M':
757
show_status(file_state, kind, new_name)
758
elif file_state == 'D':
759
show_status(file_state, kind, old_name)
760
elif file_state == 'R':
761
show_status(file_state, kind,
762
old_name + ' => ' + new_name)
763
764
revno += 1
765
precursor = p
1072
766
1073
767
1074
768
def rename_one(self, from_rel, to_rel):
1075
"""Rename one file.
1076
1077
This can change the directory or the filename or both.
1078
"""
1079
self.lock_write()
769
tree = self.working_tree()
770
inv = tree.inventory
771
if not tree.has_filename(from_rel):
772
bailout("can't rename: old working file %r does not exist" % from_rel)
773
if tree.has_filename(to_rel):
774
bailout("can't rename: new working file %r already exists" % to_rel)
775
776
file_id = inv.path2id(from_rel)
777
if file_id == None:
778
bailout("can't rename: old name %r is not versioned" % from_rel)
779
780
if inv.path2id(to_rel):
781
bailout("can't rename: new name %r is already versioned" % to_rel)
782
783
to_dir, to_tail = os.path.split(to_rel)
784
to_dir_id = inv.path2id(to_dir)
785
if to_dir_id == None and to_dir != '':
786
bailout("can't determine destination directory id for %r" % to_dir)
787
788
mutter("rename_one:")
789
mutter(" file_id {%s}" % file_id)
790
mutter(" from_rel %r" % from_rel)
791
mutter(" to_rel %r" % to_rel)
792
mutter(" to_dir %r" % to_dir)
793
mutter(" to_dir_id {%s}" % to_dir_id)
794
795
inv.rename(file_id, to_dir_id, to_tail)
796
797
print "%s => %s" % (from_rel, to_rel)
798
799
from_abs = self.abspath(from_rel)
800
to_abs = self.abspath(to_rel)
1080
801
try:
1081
tree = self.working_tree()
1082
inv = tree.inventory
1083
if not tree.has_filename(from_rel):
1084
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1085
if tree.has_filename(to_rel):
1086
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1087
1088
file_id = inv.path2id(from_rel)
1089
if file_id == None:
1090
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1091
1092
if inv.path2id(to_rel):
1093
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1094
1095
to_dir, to_tail = os.path.split(to_rel)
1096
to_dir_id = inv.path2id(to_dir)
1097
if to_dir_id == None and to_dir != '':
1098
raise BzrError("can't determine destination directory id for %r" % to_dir)
1099
1100
mutter("rename_one:")
1101
mutter(" file_id {%s}" % file_id)
1102
mutter(" from_rel %r" % from_rel)
1103
mutter(" to_rel %r" % to_rel)
1104
mutter(" to_dir %r" % to_dir)
1105
mutter(" to_dir_id {%s}" % to_dir_id)
1106
1107
inv.rename(file_id, to_dir_id, to_tail)
1108
1109
from_abs = self.abspath(from_rel)
1110
to_abs = self.abspath(to_rel)
1111
try:
1112
rename(from_abs, to_abs)
1113
except OSError, e:
1114
raise BzrError("failed to rename %r to %r: %s"
1115
% (from_abs, to_abs, e[1]),
1116
["rename rolled back"])
1117
1118
self._write_inventory(inv)
1119
finally:
1120
self.unlock()
802
os.rename(from_abs, to_abs)
803
except OSError, e:
804
bailout("failed to rename %r to %r: %s"
805
% (from_abs, to_abs, e[1]),
806
["rename rolled back"])
807
808
self._write_inventory(inv)
809
1121
810
1122
811
1123
812
def move(self, from_paths, to_name):
1130
819
1131
820
Note that to_name is only the last component of the new name;
1132
821
this doesn't change the directory.
1133
1134
This returns a list of (from_path, to_path) pairs for each
1135
entry that is moved.
1136
"""
1137
result = []
1138
self.lock_write()
1139
try:
1140
## TODO: Option to move IDs only
1141
assert not isinstance(from_paths, basestring)
1142
tree = self.working_tree()
1143
inv = tree.inventory
1144
to_abs = self.abspath(to_name)
1145
if not isdir(to_abs):
1146
raise BzrError("destination %r is not a directory" % to_abs)
1147
if not tree.has_filename(to_name):
1148
raise BzrError("destination %r not in working directory" % to_abs)
1149
to_dir_id = inv.path2id(to_name)
1150
if to_dir_id == None and to_name != '':
1151
raise BzrError("destination %r is not a versioned directory" % to_name)
1152
to_dir_ie = inv[to_dir_id]
1153
if to_dir_ie.kind not in ('directory', 'root_directory'):
1154
raise BzrError("destination %r is not a directory" % to_abs)
1155
1156
to_idpath = inv.get_idpath(to_dir_id)
1157
1158
for f in from_paths:
1159
if not tree.has_filename(f):
1160
raise BzrError("%r does not exist in working tree" % f)
1161
f_id = inv.path2id(f)
1162
if f_id == None:
1163
raise BzrError("%r is not versioned" % f)
1164
name_tail = splitpath(f)[-1]
1165
dest_path = appendpath(to_name, name_tail)
1166
if tree.has_filename(dest_path):
1167
raise BzrError("destination %r already exists" % dest_path)
1168
if f_id in to_idpath:
1169
raise BzrError("can't move %r to a subdirectory of itself" % f)
1170
1171
# OK, so there's a race here, it's possible that someone will
1172
# create a file in this interval and then the rename might be
1173
# left half-done. But we should have caught most problems.
1174
1175
for f in from_paths:
1176
name_tail = splitpath(f)[-1]
1177
dest_path = appendpath(to_name, name_tail)
1178
result.append((f, dest_path))
1179
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1180
try:
1181
rename(self.abspath(f), self.abspath(dest_path))
1182
except OSError, e:
1183
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1184
["rename rolled back"])
1185
1186
self._write_inventory(inv)
1187
finally:
1188
self.unlock()
1189
1190
return result
1191
1192
1193
def revert(self, filenames, old_tree=None, backups=True):
1194
"""Restore selected files to the versions from a previous tree.
1195
1196
backups
1197
If true (default) backups are made of files before
1198
they're renamed.
1199
"""
1200
from bzrlib.errors import NotVersionedError, BzrError
1201
from bzrlib.atomicfile import AtomicFile
1202
from bzrlib.osutils import backup_file
1203
1204
inv = self.read_working_inventory()
1205
if old_tree is None:
1206
old_tree = self.basis_tree()
1207
old_inv = old_tree.inventory
1208
1209
nids = []
1210
for fn in filenames:
1211
file_id = inv.path2id(fn)
1212
if not file_id:
1213
raise NotVersionedError("not a versioned file", fn)
1214
if not old_inv.has_id(file_id):
1215
raise BzrError("file not present in old tree", fn, file_id)
1216
nids.append((fn, file_id))
1217
1218
# TODO: Rename back if it was previously at a different location
1219
1220
# TODO: If given a directory, restore the entire contents from
1221
# the previous version.
1222
1223
# TODO: Make a backup to a temporary file.
1224
1225
# TODO: If the file previously didn't exist, delete it?
1226
for fn, file_id in nids:
1227
backup_file(fn)
1228
1229
f = AtomicFile(fn, 'wb')
1230
try:
1231
f.write(old_tree.get_file(file_id).read())
1232
f.commit()
1233
finally:
1234
f.close()
1235
1236
1237
def pending_merges(self):
1238
"""Return a list of pending merges.
1239
1240
These are revisions that have been merged into the working
1241
directory but not yet committed.
1242
"""
1243
cfn = self._rel_controlfilename('pending-merges')
1244
if not self._transport.has(cfn):
1245
return []
1246
p = []
1247
for l in self.controlfile('pending-merges', 'r').readlines():
1248
p.append(l.rstrip('\n'))
1249
return p
1250
1251
1252
def add_pending_merge(self, *revision_ids):
1253
# TODO: Perhaps should check at this point that the
1254
# history of the revision is actually present?
1255
p = self.pending_merges()
1256
updated = False
1257
for rev_id in revision_ids:
1258
if rev_id in p:
1259
continue
1260
p.append(rev_id)
1261
updated = True
1262
if updated:
1263
self.set_pending_merges(p)
1264
1265
def set_pending_merges(self, rev_list):
1266
self.lock_write()
1267
try:
1268
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1269
finally:
1270
self.unlock()
1271
1272
1273
def get_parent(self):
1274
"""Return the parent location of the branch.
1275
1276
This is the default location for push/pull/missing. The usual
1277
pattern is that the user can override it by specifying a
1278
location.
1279
"""
1280
import errno
1281
_locs = ['parent', 'pull', 'x-pull']
1282
for l in _locs:
1283
try:
1284
return self.controlfile(l, 'r').read().strip('\n')
1285
except IOError, e:
1286
if e.errno != errno.ENOENT:
1287
raise
1288
return None
1289
1290
1291
def set_parent(self, url):
1292
# TODO: Maybe delete old location files?
1293
from bzrlib.atomicfile import AtomicFile
1294
self.lock_write()
1295
try:
1296
f = AtomicFile(self.controlfilename('parent'))
1297
try:
1298
f.write(url + '\n')
1299
f.commit()
1300
finally:
1301
f.close()
1302
finally:
1303
self.unlock()
1304
1305
def check_revno(self, revno):
1306
"""\
1307
Check whether a revno corresponds to any revision.
1308
Zero (the NULL revision) is considered valid.
1309
"""
1310
if revno != 0:
1311
self.check_real_revno(revno)
1312
1313
def check_real_revno(self, revno):
1314
"""\
1315
Check whether a revno corresponds to a real revision.
1316
Zero (the NULL revision) is considered invalid
1317
"""
1318
if revno < 1 or revno > self.revno():
1319
raise InvalidRevisionNumber(revno)
1320
1321
1322
1323
1324
1325
class ScratchBranch(_Branch):
822
"""
823
## TODO: Option to move IDs only
824
assert not isinstance(from_paths, basestring)
825
tree = self.working_tree()
826
inv = tree.inventory
827
to_abs = self.abspath(to_name)
828
if not isdir(to_abs):
829
bailout("destination %r is not a directory" % to_abs)
830
if not tree.has_filename(to_name):
831
bailout("destination %r not in working directory" % to_abs)
832
to_dir_id = inv.path2id(to_name)
833
if to_dir_id == None and to_name != '':
834
bailout("destination %r is not a versioned directory" % to_name)
835
to_dir_ie = inv[to_dir_id]
836
if to_dir_ie.kind not in ('directory', 'root_directory'):
837
bailout("destination %r is not a directory" % to_abs)
838
839
to_idpath = Set(inv.get_idpath(to_dir_id))
840
841
for f in from_paths:
842
if not tree.has_filename(f):
843
bailout("%r does not exist in working tree" % f)
844
f_id = inv.path2id(f)
845
if f_id == None:
846
bailout("%r is not versioned" % f)
847
name_tail = splitpath(f)[-1]
848
dest_path = appendpath(to_name, name_tail)
849
if tree.has_filename(dest_path):
850
bailout("destination %r already exists" % dest_path)
851
if f_id in to_idpath:
852
bailout("can't move %r to a subdirectory of itself" % f)
853
854
# OK, so there's a race here, it's possible that someone will
855
# create a file in this interval and then the rename might be
856
# left half-done. But we should have caught most problems.
857
858
for f in from_paths:
859
name_tail = splitpath(f)[-1]
860
dest_path = appendpath(to_name, name_tail)
861
print "%s => %s" % (f, dest_path)
862
inv.rename(inv.path2id(f), to_dir_id, name_tail)
863
try:
864
os.rename(self.abspath(f), self.abspath(dest_path))
865
except OSError, e:
866
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
867
["rename rolled back"])
868
869
self._write_inventory(inv)
870
871
872
873
def show_status(self, show_all=False):
874
"""Display single-line status for non-ignored working files.
875
876
The list is show sorted in order by file name.
877
878
>>> b = ScratchBranch(files=['foo', 'foo~'])
879
>>> b.show_status()
880
? foo
881
>>> b.add('foo')
882
>>> b.show_status()
883
A foo
884
>>> b.commit("add foo")
885
>>> b.show_status()
886
>>> os.unlink(b.abspath('foo'))
887
>>> b.show_status()
888
D foo
889
890
891
TODO: Get state for single files.
892
893
TODO: Perhaps show a slash at the end of directory names.
894
895
"""
896
897
# We have to build everything into a list first so that it can
898
# sorted by name, incorporating all the different sources.
899
900
# FIXME: Rather than getting things in random order and then sorting,
901
# just step through in order.
902
903
# Interesting case: the old ID for a file has been removed,
904
# but a new file has been created under that name.
905
906
old = self.basis_tree()
907
new = self.working_tree()
908
909
for fs, fid, oldname, newname, kind in diff_trees(old, new):
910
if fs == 'R':
911
show_status(fs, kind,
912
oldname + ' => ' + newname)
913
elif fs == 'A' or fs == 'M':
914
show_status(fs, kind, newname)
915
elif fs == 'D':
916
show_status(fs, kind, oldname)
917
elif fs == '.':
918
if show_all:
919
show_status(fs, kind, newname)
920
elif fs == 'I':
921
if show_all:
922
show_status(fs, kind, newname)
923
elif fs == '?':
924
show_status(fs, kind, newname)
925
else:
926
bailout("weird file state %r" % ((fs, fid),))
927
928
929
930
class ScratchBranch(Branch):
1326
931
"""Special test class: a branch that cleans up after itself.
1327
932
1328
933
>>> b = ScratchBranch()
1329
934
>>> isdir(b.base)
1330
935
True
1331
936
>>> bd = b.base
1332
>>> b.destroy()
937
>>> del b
1333
938
>>> isdir(bd)
1334
939
False
1335
940
"""
1336
def __init__(self, files=[], dirs=[], base=None):
941
def __init__(self, files=[], dirs=[]):
1337
942
"""Make a test branch.
1338
943
1339
944
This creates a temporary directory and runs init-tree in it.
1340
945
1341
946
If any files are listed, they are created in the working copy.
1342
947
"""
1343
from tempfile import mkdtemp
1344
init = False
1345
if base is None:
1346
base = mkdtemp()
1347
init = True
1348
if isinstance(base, basestring):
1349
base = get_transport(base)
1350
_Branch.__init__(self, base, init=init)
948
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1351
949
for d in dirs:
1352
self._transport.mkdir(d)
950
os.mkdir(self.abspath(d))
1353
951
1354
952
for f in files:
1355
self._transport.put(f, 'content of %s' % f)
1356
1357
1358
def clone(self):
1359
"""
1360
>>> orig = ScratchBranch(files=["file1", "file2"])
1361
>>> clone = orig.clone()
1362
>>> if os.name != 'nt':
1363
... os.path.samefile(orig.base, clone.base)
1364
... else:
1365
... orig.base == clone.base
1366
...
1367
False
1368
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1369
True
1370
"""
1371
from shutil import copytree
1372
from tempfile import mkdtemp
1373
base = mkdtemp()
1374
os.rmdir(base)
1375
copytree(self.base, base, symlinks=True)
1376
return ScratchBranch(base=base)
953
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
954
1377
955
1378
956
def __del__(self):
1379
self.destroy()
1380
1381
def destroy(self):
1382
957
"""Destroy the test branch, removing the scratch directory."""
1383
from shutil import rmtree
1384
958
try:
1385
if self.base:
1386
mutter("delete ScratchBranch %s" % self.base)
1387
rmtree(self.base)
1388
except OSError, e:
959
shutil.rmtree(self.base)
960
except OSError:
1389
961
# Work around for shutil.rmtree failing on Windows when
1390
962
# readonly files are encountered
1391
mutter("hit exception in destroying ScratchBranch: %s" % e)
1392
963
for root, dirs, files in os.walk(self.base, topdown=False):
1393
964
for name in files:
1394
965
os.chmod(os.path.join(root, name), 0700)
1395
rmtree(self.base)
1396
self._transport = None
966
shutil.rmtree(self.base)
1397
967
1398
968
1399
969
1416
986
1417
987
1418
988
989
def _gen_revision_id(when):
990
"""Return new revision-id."""
991
s = '%s-%s-' % (user_email(), compact_date(when))
992
s += hexlify(rand_bytes(8))
993
return s
994
995
1419
996
def gen_file_id(name):
1420
997
"""Return new file id.
1421
998
1422
999
This should probably generate proper UUIDs, but for the moment we
1423
1000
cope with just randomness because running uuidgen every time is
1424
1001
slow."""
1425
import re
1426
from binascii import hexlify
1427
from time import time
1428
1429
# get last component
1430
1002
idx = name.rfind('/')
1431
1003
if idx != -1:
1432
1004
name = name[idx+1 : ]
1433
idx = name.rfind('\\')
1434
if idx != -1:
1435
name = name[idx+1 : ]
1436
1005
1437
# make it not a hidden file
1438
1006
name = name.lstrip('.')
1439
1007
1440
# remove any wierd characters; we don't escape them but rather
1441
# just pull them out
1442
name = re.sub(r'[^\w.]', '', name)
1443
1444
1008
s = hexlify(rand_bytes(8))
1445
return '-'.join((name, compact_date(time()), s))
1446
1447
1448
def gen_root_id():
1449
"""Return a new tree-root file id."""
1450
return gen_file_id('TREE_ROOT')
1451
1452
1009
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1