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