« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 260
- compare with another revision
- download diff
- download tarball
- view history from revision 260
- Committer: Martin Pool
- Date: 2005-04-15 02:41:52 UTC
- Revision ID: mbp@sourcefrog.net-20050415024152-caf2e2f1c3ec6129
- remove atexit() dependency for writing out execution times
- files added:
- bzrlib/mdiff.py
- files removed:
- BRANCH.TODO
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
import shutil
19
import sys
20
import os
21
import errno
22
from warnings import warn
23
from cStringIO import StringIO
18
from sets import Set
24
19
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
25
23
26
24
import bzrlib
27
from bzrlib.trace import mutter, note
28
from bzrlib.osutils import (isdir, quotefn,
29
rename, splitpath, sha_file,
30
file_kind, abspath, normpath, pathjoin)
31
import bzrlib.errors as errors
32
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
33
NoSuchRevision, HistoryMissing, NotBranchError,
34
DivergedBranches, LockError, UnlistableStore,
35
UnlistableBranch, NoSuchFile, NotVersionedError,
36
NoWorkingTree)
37
from bzrlib.textui import show_status
38
from bzrlib.config import TreeConfig
39
from bzrlib.delta import compare_trees
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles
43
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
44
from bzrlib.repository import Repository
45
from bzrlib.store import copy_all
46
import bzrlib.transactions as transactions
47
from bzrlib.transport import Transport, get_transport
48
from bzrlib.tree import EmptyTree, RevisionTree
49
import bzrlib.ui
50
import bzrlib.xml5
51
52
53
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
54
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
55
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"
56
39
## TODO: Maybe include checks for common corruption of newlines, etc?
57
40
58
41
59
# TODO: Some operations like log might retrieve the same revisions
60
# repeatedly to calculate deltas. We could perhaps have a weakref
61
# cache in memory to make this faster. In general anything can be
62
# cached in memory between lock and unlock operations.
63
64
def find_branch(*ignored, **ignored_too):
65
# XXX: leave this here for about one release, then remove it
66
raise NotImplementedError('find_branch() is not supported anymore, '
67
'please use one of the new branch constructors')
68
69
70
def needs_read_lock(unbound):
71
"""Decorate unbound to take out and release a read lock."""
72
def decorated(self, *args, **kwargs):
73
self.lock_read()
74
try:
75
return unbound(self, *args, **kwargs)
76
finally:
77
self.unlock()
78
return decorated
79
80
81
def needs_write_lock(unbound):
82
"""Decorate unbound to take out and release a write lock."""
83
def decorated(self, *args, **kwargs):
84
self.lock_write()
85
try:
86
return unbound(self, *args, **kwargs)
87
finally:
88
self.unlock()
89
return decorated
42
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
45
46
It is not necessary that f exists.
47
48
Basically we keep looking up until we find the control directory or
49
run into the root."""
50
if f == None:
51
f = os.getcwd()
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
54
else:
55
f = os.path.abspath(f)
56
57
orig_f = f
58
59
while True:
60
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
61
return f
62
head, tail = os.path.split(f)
63
if head == f:
64
# reached the root, whatever that may be
65
raise BzrError('%r is not in a branch' % orig_f)
66
f = head
67
68
90
69
91
70
######################################################################
92
71
# branch objects
93
72
94
class Branch(object):
73
class Branch:
95
74
"""Branch holding a history of revisions.
96
75
97
base
98
Base directory/url of the branch.
76
TODO: Perhaps use different stores for different classes of object,
77
so that we can keep track of how much space each one uses,
78
or garbage-collect them.
79
80
TODO: Add a RemoteBranch subclass. For the basic case of read-only
81
HTTP access this should be very easy by,
82
just redirecting controlfile access into HTTP requests.
83
We would need a RemoteStore working similarly.
84
85
TODO: Keep the on-disk branch locked while the object exists.
86
87
TODO: mkdir() method.
99
88
"""
100
base = None
101
102
def __init__(self, *ignored, **ignored_too):
103
raise NotImplementedError('The Branch class is abstract')
104
105
@staticmethod
106
def open_downlevel(base):
107
"""Open a branch which may be of an old format.
108
109
Only local branches are supported."""
110
return BzrBranch(get_transport(base), relax_version_check=True)
111
112
@staticmethod
113
def open(base):
114
"""Open an existing branch, rooted at 'base' (url)"""
115
t = get_transport(base)
116
mutter("trying to open %r with transport %r", base, t)
117
return BzrBranch(t)
118
119
@staticmethod
120
def open_containing(url):
121
"""Open an existing branch which contains url.
122
123
This probes for a branch at url, and searches upwards from there.
124
125
Basically we keep looking up until we find the control directory or
126
run into the root. If there isn't one, raises NotBranchError.
127
If there is one, it is returned, along with the unused portion of url.
128
"""
129
t = get_transport(url)
130
while True:
89
def __init__(self, base, init=False, find_root=True):
90
"""Create new branch object at a particular location.
91
92
base -- Base directory for the branch.
93
94
init -- If True, create new control files in a previously
95
unversioned directory. If False, the branch must already
96
be versioned.
97
98
find_root -- If true and init is false, find the root of the
99
existing branch containing base.
100
101
In the test suite, creation of new trees is tested using the
102
`ScratchBranch` class.
103
"""
104
if init:
105
self.base = os.path.realpath(base)
106
self._make_control()
107
elif find_root:
108
self.base = find_branch_root(base)
109
else:
110
self.base = os.path.realpath(base)
111
if not isdir(self.controlfilename('.')):
112
bailout("not a bzr branch: %s" % quotefn(base),
113
['use "bzr init" to initialize a new working tree',
114
'current bzr can only operate from top-of-tree'])
115
self._check_format()
116
117
self.text_store = ImmutableStore(self.controlfilename('text-store'))
118
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
119
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
120
121
122
def __str__(self):
123
return '%s(%r)' % (self.__class__.__name__, self.base)
124
125
126
__repr__ = __str__
127
128
129
def abspath(self, name):
130
"""Return absolute filename for something in the branch"""
131
return os.path.join(self.base, name)
132
133
134
def relpath(self, path):
135
"""Return path relative to this branch of something inside it.
136
137
Raises an error if path is not in this branch."""
138
rp = os.path.realpath(path)
139
# FIXME: windows
140
if not rp.startswith(self.base):
141
bailout("path %r is not within branch %r" % (rp, self.base))
142
rp = rp[len(self.base):]
143
rp = rp.lstrip(os.sep)
144
return rp
145
146
147
def controlfilename(self, file_or_path):
148
"""Return location relative to branch."""
149
if isinstance(file_or_path, types.StringTypes):
150
file_or_path = [file_or_path]
151
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
152
153
154
def controlfile(self, file_or_path, mode='r'):
155
"""Open a control file for this branch.
156
157
There are two classes of file in the control directory: text
158
and binary. binary files are untranslated byte streams. Text
159
control files are stored with Unix newlines and in UTF-8, even
160
if the platform or locale defaults are different.
161
"""
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
# codecs uses line buffering by default; don't want that.
170
import codecs
171
return codecs.open(fn, mode + 'b', 'utf-8',
172
buffering=60000)
173
else:
174
raise BzrError("invalid controlfile mode %r" % mode)
175
176
177
178
def _make_control(self):
179
os.mkdir(self.controlfilename([]))
180
self.controlfile('README', 'w').write(
181
"This is a Bazaar-NG control directory.\n"
182
"Do not change any files in this directory.")
183
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
184
for d in ('text-store', 'inventory-store', 'revision-store'):
185
os.mkdir(self.controlfilename(d))
186
for f in ('revision-history', 'merged-patches',
187
'pending-merged-patches', 'branch-name'):
188
self.controlfile(f, 'w').write('')
189
mutter('created control directory in ' + self.base)
190
Inventory().write_xml(self.controlfile('inventory','w'))
191
192
193
def _check_format(self):
194
"""Check this branch format is supported.
195
196
The current tool only supports the current unstable format.
197
198
In the future, we might need different in-memory Branch
199
classes to support downlevel branches. But not yet.
200
"""
201
# This ignores newlines so that we can open branches created
202
# on Windows from Linux and so on. I think it might be better
203
# to always make all internal files in unix format.
204
fmt = self.controlfile('branch-format', 'r').read()
205
fmt.replace('\r\n', '')
206
if fmt != BZR_BRANCH_FORMAT:
207
bailout('sorry, branch format %r not supported' % fmt,
208
['use a different bzr version',
209
'or remove the .bzr directory and "bzr init" again'])
210
211
212
def read_working_inventory(self):
213
"""Read the working inventory."""
214
before = time.time()
215
# ElementTree does its own conversion from UTF-8, so open in
216
# binary.
217
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
218
mutter("loaded inventory of %d items in %f"
219
% (len(inv), time.time() - before))
220
return inv
221
222
223
def _write_inventory(self, inv):
224
"""Update the working inventory.
225
226
That is to say, the inventory describing changes underway, that
227
will be committed to the next revision.
228
"""
229
## TODO: factor out to atomicfile? is rename safe on windows?
230
## TODO: Maybe some kind of clean/dirty marker on inventory?
231
tmpfname = self.controlfilename('inventory.tmp')
232
tmpf = file(tmpfname, 'wb')
233
inv.write_xml(tmpf)
234
tmpf.close()
235
inv_fname = self.controlfilename('inventory')
236
if sys.platform == 'win32':
237
os.remove(inv_fname)
238
os.rename(tmpfname, inv_fname)
239
mutter('wrote working inventory')
240
241
242
inventory = property(read_working_inventory, _write_inventory, None,
243
"""Inventory for the working copy.""")
244
245
246
def add(self, files, verbose=False):
247
"""Make files versioned.
248
249
Note that the command line normally calls smart_add instead.
250
251
This puts the files in the Added state, so that they will be
252
recorded by the next commit.
253
254
TODO: Perhaps have an option to add the ids even if the files do
255
not (yet) exist.
256
257
TODO: Perhaps return the ids of the files? But then again it
258
is easy to retrieve them if they're needed.
259
260
TODO: Option to specify file id.
261
262
TODO: Adding a directory should optionally recurse down and
263
add all non-ignored children. Perhaps do that in a
264
higher-level method.
265
266
>>> b = ScratchBranch(files=['foo'])
267
>>> 'foo' in b.unknowns()
268
True
269
>>> b.show_status()
270
? foo
271
>>> b.add('foo')
272
>>> 'foo' in b.unknowns()
273
False
274
>>> bool(b.inventory.path2id('foo'))
275
True
276
>>> b.show_status()
277
A foo
278
279
>>> b.add('foo')
280
Traceback (most recent call last):
281
...
282
BzrError: ('foo is already versioned', [])
283
284
>>> b.add(['nothere'])
285
Traceback (most recent call last):
286
BzrError: ('cannot add: not a regular file or directory: nothere', [])
287
"""
288
289
# TODO: Re-adding a file that is removed in the working copy
290
# should probably put it back with the previous ID.
291
if isinstance(files, types.StringTypes):
292
files = [files]
293
294
inv = self.read_working_inventory()
295
for f in files:
296
if is_control_file(f):
297
bailout("cannot add control file %s" % quotefn(f))
298
299
fp = splitpath(f)
300
301
if len(fp) == 0:
302
bailout("cannot add top-level %r" % f)
303
304
fullpath = os.path.normpath(self.abspath(f))
305
131
306
try:
132
return BzrBranch(t), t.relpath(url)
133
except NotBranchError, e:
134
mutter('not a branch in: %r %s', t.base, e)
135
new_t = t.clone('..')
136
if new_t.base == t.base:
137
# reached the root, whatever that may be
138
raise NotBranchError(path=url)
139
t = new_t
140
141
@staticmethod
142
def initialize(base):
143
"""Create a new branch, rooted at 'base' (url)"""
144
t = get_transport(unicode(base))
145
return BzrBranch(t, init=True)
146
147
def setup_caching(self, cache_root):
148
"""Subclasses that care about caching should override this, and set
149
up cached stores located under cache_root.
150
"""
151
self.cache_root = cache_root
152
153
def _get_nick(self):
154
cfg = self.tree_config()
155
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
156
157
def _set_nick(self, nick):
158
cfg = self.tree_config()
159
cfg.set_option(nick, "nickname")
160
assert cfg.get_option("nickname") == nick
161
162
nick = property(_get_nick, _set_nick)
163
164
def push_stores(self, branch_to):
165
"""Copy the content of this branches store to branch_to."""
166
raise NotImplementedError('push_stores is abstract')
167
168
def lock_write(self):
169
raise NotImplementedError('lock_write is abstract')
170
171
def lock_read(self):
172
raise NotImplementedError('lock_read is abstract')
173
174
def unlock(self):
175
raise NotImplementedError('unlock is abstract')
176
177
def abspath(self, name):
178
"""Return absolute filename for something in the branch
179
180
XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
method and not a tree method.
182
"""
183
raise NotImplementedError('abspath is abstract')
184
185
def get_root_id(self):
186
"""Return the id of this branches root"""
187
raise NotImplementedError('get_root_id is abstract')
188
189
def print_file(self, file, revision_id):
307
kind = file_kind(fullpath)
308
except OSError:
309
# maybe something better?
310
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
311
312
if kind != 'file' and kind != 'directory':
313
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
314
315
file_id = gen_file_id(f)
316
inv.add_path(f, kind=kind, file_id=file_id)
317
318
if verbose:
319
show_status('A', kind, quotefn(f))
320
321
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
322
323
self._write_inventory(inv)
324
325
326
def print_file(self, file, revno):
190
327
"""Print `file` to stdout."""
191
raise NotImplementedError('print_file is abstract')
192
193
def append_revision(self, *revision_ids):
194
raise NotImplementedError('append_revision is abstract')
195
196
def set_revision_history(self, rev_history):
197
raise NotImplementedError('set_revision_history is abstract')
328
tree = self.revision_tree(self.lookup_revision(revno))
329
# use inventory as it was in that revision
330
file_id = tree.inventory.path2id(file)
331
if not file_id:
332
bailout("%r is not present in revision %d" % (file, revno))
333
tree.print_file(file_id)
334
335
336
def remove(self, files, verbose=False):
337
"""Mark nominated files for removal from the inventory.
338
339
This does not remove their text. This does not run on
340
341
TODO: Refuse to remove modified files unless --force is given?
342
343
>>> b = ScratchBranch(files=['foo'])
344
>>> b.add('foo')
345
>>> b.inventory.has_filename('foo')
346
True
347
>>> b.remove('foo')
348
>>> b.working_tree().has_filename('foo')
349
True
350
>>> b.inventory.has_filename('foo')
351
False
352
353
>>> b = ScratchBranch(files=['foo'])
354
>>> b.add('foo')
355
>>> b.commit('one')
356
>>> b.remove('foo')
357
>>> b.commit('two')
358
>>> b.inventory.has_filename('foo')
359
False
360
>>> b.basis_tree().has_filename('foo')
361
False
362
>>> b.working_tree().has_filename('foo')
363
True
364
365
TODO: Do something useful with directories.
366
367
TODO: Should this remove the text or not? Tough call; not
368
removing may be useful and the user can just use use rm, and
369
is the opposite of add. Removing it is consistent with most
370
other tools. Maybe an option.
371
"""
372
## TODO: Normalize names
373
## TODO: Remove nested loops; better scalability
374
375
if isinstance(files, types.StringTypes):
376
files = [files]
377
378
tree = self.working_tree()
379
inv = tree.inventory
380
381
# do this before any modifications
382
for f in files:
383
fid = inv.path2id(f)
384
if not fid:
385
bailout("cannot remove unversioned file %s" % quotefn(f))
386
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
387
if verbose:
388
# having remove it, it must be either ignored or unknown
389
if tree.is_ignored(f):
390
new_status = 'I'
391
else:
392
new_status = '?'
393
show_status(new_status, inv[fid].kind, quotefn(f))
394
del inv[fid]
395
396
self._write_inventory(inv)
397
398
399
def unknowns(self):
400
"""Return all unknown files.
401
402
These are files in the working directory that are not versioned or
403
control files or ignored.
404
405
>>> b = ScratchBranch(files=['foo', 'foo~'])
406
>>> list(b.unknowns())
407
['foo']
408
>>> b.add('foo')
409
>>> list(b.unknowns())
410
[]
411
>>> b.remove('foo')
412
>>> list(b.unknowns())
413
['foo']
414
"""
415
return self.working_tree().unknowns()
416
417
418
def commit(self, message, timestamp=None, timezone=None,
419
committer=None,
420
verbose=False):
421
"""Commit working copy as a new revision.
422
423
The basic approach is to add all the file texts into the
424
store, then the inventory, then make a new revision pointing
425
to that inventory and store that.
426
427
This is not quite safe if the working copy changes during the
428
commit; for the moment that is simply not allowed. A better
429
approach is to make a temporary copy of the files before
430
computing their hashes, and then add those hashes in turn to
431
the inventory. This should mean at least that there are no
432
broken hash pointers. There is no way we can get a snapshot
433
of the whole directory at an instant. This would also have to
434
be robust against files disappearing, moving, etc. So the
435
whole thing is a bit hard.
436
437
timestamp -- if not None, seconds-since-epoch for a
438
postdated/predated commit.
439
"""
440
441
## TODO: Show branch names
442
443
# TODO: Don't commit if there are no changes, unless forced?
444
445
# First walk over the working inventory; and both update that
446
# and also build a new revision inventory. The revision
447
# inventory needs to hold the text-id, sha1 and size of the
448
# actual file versions committed in the revision. (These are
449
# not present in the working inventory.) We also need to
450
# detect missing/deleted files, and remove them from the
451
# working inventory.
452
453
work_inv = self.read_working_inventory()
454
inv = Inventory()
455
basis = self.basis_tree()
456
basis_inv = basis.inventory
457
missing_ids = []
458
for path, entry in work_inv.iter_entries():
459
## TODO: Cope with files that have gone missing.
460
461
## TODO: Check that the file kind has not changed from the previous
462
## revision of this file (if any).
463
464
entry = entry.copy()
465
466
p = self.abspath(path)
467
file_id = entry.file_id
468
mutter('commit prep file %s, id %r ' % (p, file_id))
469
470
if not os.path.exists(p):
471
mutter(" file is missing, removing from inventory")
472
if verbose:
473
show_status('D', entry.kind, quotefn(path))
474
missing_ids.append(file_id)
475
continue
476
477
# TODO: Handle files that have been deleted
478
479
# TODO: Maybe a special case for empty files? Seems a
480
# waste to store them many times.
481
482
inv.add(entry)
483
484
if basis_inv.has_id(file_id):
485
old_kind = basis_inv[file_id].kind
486
if old_kind != entry.kind:
487
bailout("entry %r changed kind from %r to %r"
488
% (file_id, old_kind, entry.kind))
489
490
if entry.kind == 'directory':
491
if not isdir(p):
492
bailout("%s is entered as directory but not a directory" % quotefn(p))
493
elif entry.kind == 'file':
494
if not isfile(p):
495
bailout("%s is entered as file but is not a file" % quotefn(p))
496
497
content = file(p, 'rb').read()
498
499
entry.text_sha1 = sha_string(content)
500
entry.text_size = len(content)
501
502
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
503
if (old_ie
504
and (old_ie.text_size == entry.text_size)
505
and (old_ie.text_sha1 == entry.text_sha1)):
506
## assert content == basis.get_file(file_id).read()
507
entry.text_id = basis_inv[file_id].text_id
508
mutter(' unchanged from previous text_id {%s}' %
509
entry.text_id)
510
511
else:
512
entry.text_id = gen_file_id(entry.name)
513
self.text_store.add(content, entry.text_id)
514
mutter(' stored with text_id {%s}' % entry.text_id)
515
if verbose:
516
if not old_ie:
517
state = 'A'
518
elif (old_ie.name == entry.name
519
and old_ie.parent_id == entry.parent_id):
520
state = 'M'
521
else:
522
state = 'R'
523
524
show_status(state, entry.kind, quotefn(path))
525
526
for file_id in missing_ids:
527
# have to do this later so we don't mess up the iterator.
528
# since parents may be removed before their children we
529
# have to test.
530
531
# FIXME: There's probably a better way to do this; perhaps
532
# the workingtree should know how to filter itself.
533
if work_inv.has_id(file_id):
534
del work_inv[file_id]
535
536
537
inv_id = rev_id = _gen_revision_id(time.time())
538
539
inv_tmp = tempfile.TemporaryFile()
540
inv.write_xml(inv_tmp)
541
inv_tmp.seek(0)
542
self.inventory_store.add(inv_tmp, inv_id)
543
mutter('new inventory_id is {%s}' % inv_id)
544
545
self._write_inventory(work_inv)
546
547
if timestamp == None:
548
timestamp = time.time()
549
550
if committer == None:
551
committer = username()
552
553
if timezone == None:
554
timezone = local_time_offset()
555
556
mutter("building commit log message")
557
rev = Revision(timestamp=timestamp,
558
timezone=timezone,
559
committer=committer,
560
precursor = self.last_patch(),
561
message = message,
562
inventory_id=inv_id,
563
revision_id=rev_id)
564
565
rev_tmp = tempfile.TemporaryFile()
566
rev.write_xml(rev_tmp)
567
rev_tmp.seek(0)
568
self.revision_store.add(rev_tmp, rev_id)
569
mutter("new revision_id is {%s}" % rev_id)
570
571
## XXX: Everything up to here can simply be orphaned if we abort
572
## the commit; it will leave junk files behind but that doesn't
573
## matter.
574
575
## TODO: Read back the just-generated changeset, and make sure it
576
## applies and recreates the right state.
577
578
## TODO: Also calculate and store the inventory SHA1
579
mutter("committing patch r%d" % (self.revno() + 1))
580
581
582
self.append_revision(rev_id)
583
584
if verbose:
585
note("commited r%d" % self.revno())
586
587
588
def append_revision(self, revision_id):
589
mutter("add {%s} to revision-history" % revision_id)
590
rev_history = self.revision_history()
591
592
tmprhname = self.controlfilename('revision-history.tmp')
593
rhname = self.controlfilename('revision-history')
594
595
f = file(tmprhname, 'wt')
596
rev_history.append(revision_id)
597
f.write('\n'.join(rev_history))
598
f.write('\n')
599
f.close()
600
601
if sys.platform == 'win32':
602
os.remove(rhname)
603
os.rename(tmprhname, rhname)
604
605
606
607
def get_revision(self, revision_id):
608
"""Return the Revision object for a named revision"""
609
r = Revision.read_xml(self.revision_store[revision_id])
610
assert r.revision_id == revision_id
611
return r
612
613
614
def get_inventory(self, inventory_id):
615
"""Get Inventory object by hash.
616
617
TODO: Perhaps for this and similar methods, take a revision
618
parameter which can be either an integer revno or a
619
string hash."""
620
i = Inventory.read_xml(self.inventory_store[inventory_id])
621
return i
622
623
624
def get_revision_inventory(self, revision_id):
625
"""Return inventory of a past revision."""
626
if revision_id == None:
627
return Inventory()
628
else:
629
return self.get_inventory(self.get_revision(revision_id).inventory_id)
630
198
631
199
632
def revision_history(self):
200
"""Return sequence of revision hashes on to this branch."""
201
raise NotImplementedError('revision_history is abstract')
633
"""Return sequence of revision hashes on to this branch.
634
635
>>> ScratchBranch().revision_history()
636
[]
637
"""
638
return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]
639
202
640
203
641
def revno(self):
204
642
"""Return current revision number for this branch.
205
643
206
644
That is equivalent to the number of revisions committed to
207
645
this branch.
646
647
>>> b = ScratchBranch()
648
>>> b.revno()
649
0
650
>>> b.commit('no foo')
651
>>> b.revno()
652
1
208
653
"""
209
654
return len(self.revision_history())
210
655
211
def last_revision(self):
212
"""Return last patch hash, or None if no history."""
656
657
def last_patch(self):
658
"""Return last patch hash, or None if no history.
659
660
>>> ScratchBranch().last_patch() == None
661
True
662
"""
213
663
ph = self.revision_history()
214
664
if ph:
215
665
return ph[-1]
216
666
else:
217
667
return None
218
219
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
220
"""Return a list of new revisions that would perfectly fit.
221
222
If self and other have not diverged, return a list of the revisions
223
present in other, but missing from self.
224
225
>>> from bzrlib.commit import commit
226
>>> bzrlib.trace.silent = True
227
>>> br1 = ScratchBranch()
228
>>> br2 = ScratchBranch()
229
>>> br1.missing_revisions(br2)
230
[]
231
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
232
>>> br1.missing_revisions(br2)
233
[u'REVISION-ID-1']
234
>>> br2.missing_revisions(br1)
235
[]
236
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
237
>>> br1.missing_revisions(br2)
238
[]
239
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
240
>>> br1.missing_revisions(br2)
241
[u'REVISION-ID-2A']
242
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
243
>>> br1.missing_revisions(br2)
244
Traceback (most recent call last):
245
DivergedBranches: These branches have diverged. Try merge.
246
"""
247
self_history = self.revision_history()
248
self_len = len(self_history)
249
other_history = other.revision_history()
250
other_len = len(other_history)
251
common_index = min(self_len, other_len) -1
252
if common_index >= 0 and \
253
self_history[common_index] != other_history[common_index]:
254
raise DivergedBranches(self, other)
255
256
if stop_revision is None:
257
stop_revision = other_len
258
else:
259
assert isinstance(stop_revision, int)
260
if stop_revision > other_len:
261
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
262
return other_history[self_len:stop_revision]
263
264
265
def update_revisions(self, other, stop_revision=None):
266
"""Pull in new perfect-fit revisions."""
267
raise NotImplementedError('update_revisions is abstract')
268
269
def pullable_revisions(self, other, stop_revision):
270
raise NotImplementedError('pullable_revisions is abstract')
271
272
def revision_id_to_revno(self, revision_id):
273
"""Given a revision id, return its revno"""
274
if revision_id is None:
275
return 0
276
history = self.revision_history()
277
try:
278
return history.index(revision_id) + 1
279
except ValueError:
280
raise bzrlib.errors.NoSuchRevision(self, revision_id)
281
282
def get_rev_id(self, revno, history=None):
283
"""Find the revision id of the specified revno."""
668
669
670
def lookup_revision(self, revno):
671
"""Return revision hash for revision number."""
284
672
if revno == 0:
285
673
return None
286
if history is None:
287
history = self.revision_history()
288
elif revno <= 0 or revno > len(history):
289
raise bzrlib.errors.NoSuchRevision(self, revno)
290
return history[revno - 1]
674
675
try:
676
# list is 0-based; revisions are 1-based
677
return self.revision_history()[revno-1]
678
except IndexError:
679
raise BzrError("no such revision %s" % revno)
680
681
682
def revision_tree(self, revision_id):
683
"""Return Tree for a revision on this branch.
684
685
`revision_id` may be None for the null revision, in which case
686
an `EmptyTree` is returned."""
687
688
if revision_id == None:
689
return EmptyTree()
690
else:
691
inv = self.get_revision_inventory(revision_id)
692
return RevisionTree(self.text_store, inv)
693
291
694
292
695
def working_tree(self):
293
"""Return a `Tree` for the working copy if this is a local branch."""
294
raise NotImplementedError('working_tree is abstract')
696
"""Return a `Tree` for the working copy."""
697
return WorkingTree(self.base, self.read_working_inventory())
295
698
296
def pull(self, source, overwrite=False):
297
raise NotImplementedError('pull is abstract')
298
699
299
700
def basis_tree(self):
300
701
"""Return `Tree` object for last revision.
301
702
302
703
If there are no revisions yet, return an `EmptyTree`.
704
705
>>> b = ScratchBranch(files=['foo'])
706
>>> b.basis_tree().has_filename('foo')
707
False
708
>>> b.working_tree().has_filename('foo')
709
True
710
>>> b.add('foo')
711
>>> b.commit('add foo')
712
>>> b.basis_tree().has_filename('foo')
713
True
303
714
"""
304
return self.repository.revision_tree(self.last_revision())
715
r = self.last_patch()
716
if r == None:
717
return EmptyTree()
718
else:
719
return RevisionTree(self.text_store, self.get_revision_inventory(r))
720
721
722
723
def write_log(self, show_timezone='original', verbose=False):
724
"""Write out human-readable log of commits to this branch
725
726
utc -- If true, show dates in universal time, not local time."""
727
## TODO: Option to choose either original, utc or local timezone
728
revno = 1
729
precursor = None
730
for p in self.revision_history():
731
print '-' * 40
732
print 'revno:', revno
733
## TODO: Show hash if --id is given.
734
##print 'revision-hash:', p
735
rev = self.get_revision(p)
736
print 'committer:', rev.committer
737
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
738
show_timezone))
739
740
## opportunistic consistency check, same as check_patch_chaining
741
if rev.precursor != precursor:
742
bailout("mismatched precursor!")
743
744
print 'message:'
745
if not rev.message:
746
print ' (no message)'
747
else:
748
for l in rev.message.split('\n'):
749
print ' ' + l
750
751
if verbose == True and precursor != None:
752
print 'changed files:'
753
tree = self.revision_tree(p)
754
prevtree = self.revision_tree(precursor)
755
756
for file_state, fid, old_name, new_name, kind in \
757
diff_trees(prevtree, tree, ):
758
if file_state == 'A' or file_state == 'M':
759
show_status(file_state, kind, new_name)
760
elif file_state == 'D':
761
show_status(file_state, kind, old_name)
762
elif file_state == 'R':
763
show_status(file_state, kind,
764
old_name + ' => ' + new_name)
765
766
revno += 1
767
precursor = p
768
305
769
306
770
def rename_one(self, from_rel, to_rel):
307
"""Rename one file.
308
309
This can change the directory or the filename or both.
310
"""
311
raise NotImplementedError('rename_one is abstract')
771
tree = self.working_tree()
772
inv = tree.inventory
773
if not tree.has_filename(from_rel):
774
bailout("can't rename: old working file %r does not exist" % from_rel)
775
if tree.has_filename(to_rel):
776
bailout("can't rename: new working file %r already exists" % to_rel)
777
778
file_id = inv.path2id(from_rel)
779
if file_id == None:
780
bailout("can't rename: old name %r is not versioned" % from_rel)
781
782
if inv.path2id(to_rel):
783
bailout("can't rename: new name %r is already versioned" % to_rel)
784
785
to_dir, to_tail = os.path.split(to_rel)
786
to_dir_id = inv.path2id(to_dir)
787
if to_dir_id == None and to_dir != '':
788
bailout("can't determine destination directory id for %r" % to_dir)
789
790
mutter("rename_one:")
791
mutter(" file_id {%s}" % file_id)
792
mutter(" from_rel %r" % from_rel)
793
mutter(" to_rel %r" % to_rel)
794
mutter(" to_dir %r" % to_dir)
795
mutter(" to_dir_id {%s}" % to_dir_id)
796
797
inv.rename(file_id, to_dir_id, to_tail)
798
799
print "%s => %s" % (from_rel, to_rel)
800
801
from_abs = self.abspath(from_rel)
802
to_abs = self.abspath(to_rel)
803
try:
804
os.rename(from_abs, to_abs)
805
except OSError, e:
806
bailout("failed to rename %r to %r: %s"
807
% (from_abs, to_abs, e[1]),
808
["rename rolled back"])
809
810
self._write_inventory(inv)
811
812
312
813
313
814
def move(self, from_paths, to_name):
314
815
"""Rename files.
320
821
321
822
Note that to_name is only the last component of the new name;
322
823
this doesn't change the directory.
323
324
This returns a list of (from_path, to_path) pairs for each
325
entry that is moved.
326
"""
327
raise NotImplementedError('move is abstract')
328
329
def get_parent(self):
330
"""Return the parent location of the branch.
331
332
This is the default location for push/pull/missing. The usual
333
pattern is that the user can override it by specifying a
334
location.
335
"""
336
raise NotImplementedError('get_parent is abstract')
337
338
def get_push_location(self):
339
"""Return the None or the location to push this branch to."""
340
raise NotImplementedError('get_push_location is abstract')
341
342
def set_push_location(self, location):
343
"""Set a new push location for this branch."""
344
raise NotImplementedError('set_push_location is abstract')
345
346
def set_parent(self, url):
347
raise NotImplementedError('set_parent is abstract')
348
349
def check_revno(self, revno):
350
"""\
351
Check whether a revno corresponds to any revision.
352
Zero (the NULL revision) is considered valid.
353
"""
354
if revno != 0:
355
self.check_real_revno(revno)
356
357
def check_real_revno(self, revno):
358
"""\
359
Check whether a revno corresponds to a real revision.
360
Zero (the NULL revision) is considered invalid
361
"""
362
if revno < 1 or revno > self.revno():
363
raise InvalidRevisionNumber(revno)
364
365
def sign_revision(self, revision_id, gpg_strategy):
366
raise NotImplementedError('sign_revision is abstract')
367
368
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
369
raise NotImplementedError('store_revision_signature is abstract')
370
371
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
372
"""Copy this branch into the existing directory to_location.
373
374
Returns the newly created branch object.
375
376
revision
377
If not None, only revisions up to this point will be copied.
378
The head of the new branch will be that revision. Must be a
379
revid or None.
380
381
to_location -- The destination directory; must either exist and be
382
empty, or not exist, in which case it is created.
383
384
basis_branch
385
A local branch to copy revisions from, related to this branch.
386
This is used when branching from a remote (slow) branch, and we have
387
a local branch that might contain some relevant revisions.
388
389
to_branch_type
390
Branch type of destination branch
391
"""
392
assert isinstance(to_location, basestring)
393
if not bzrlib.osutils.lexists(to_location):
394
os.mkdir(to_location)
395
if to_branch_type is None:
396
to_branch_type = BzrBranch
397
br_to = to_branch_type.initialize(to_location)
398
mutter("copy branch from %s to %s", self, br_to)
399
if basis_branch is not None:
400
basis_branch.push_stores(br_to)
401
br_to.working_tree().set_root_id(self.get_root_id())
402
if revision is None:
403
revision = self.last_revision()
404
br_to.update_revisions(self, stop_revision=revision)
405
br_to.set_parent(self.base)
406
# circular import protection
407
from bzrlib.merge import build_working_dir
408
build_working_dir(to_location)
409
mutter("copied")
410
return br_to
411
412
class BzrBranch(Branch):
413
"""A branch stored in the actual filesystem.
414
415
Note that it's "local" in the context of the filesystem; it doesn't
416
really matter if it's on an nfs/smb/afs/coda/... share, as long as
417
it's writable, and can be accessed via the normal filesystem API.
418
419
"""
420
# We actually expect this class to be somewhat short-lived; part of its
421
# purpose is to try to isolate what bits of the branch logic are tied to
422
# filesystem access, so that in a later step, we can extricate them to
423
# a separarte ("storage") class.
424
_inventory_weave = None
425
426
# Map some sort of prefix into a namespace
427
# stuff like "revno:10", "revid:", etc.
428
# This should match a prefix with a function which accepts
429
REVISION_NAMESPACES = {}
430
431
def push_stores(self, branch_to):
432
"""See Branch.push_stores."""
433
if (self._branch_format != branch_to._branch_format
434
or self._branch_format != 4):
435
from bzrlib.fetch import greedy_fetch
436
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
437
self, self._branch_format, branch_to, branch_to._branch_format)
438
greedy_fetch(to_branch=branch_to, from_branch=self,
439
revision=self.last_revision())
440
return
441
442
store_pairs = ((self.text_store, branch_to.text_store),
443
(self.inventory_store, branch_to.inventory_store),
444
(self.revision_store, branch_to.revision_store))
445
try:
446
for from_store, to_store in store_pairs:
447
copy_all(from_store, to_store)
448
except UnlistableStore:
449
raise UnlistableBranch(from_store)
450
451
def __init__(self, transport, init=False,
452
relax_version_check=False):
453
"""Create new branch object at a particular location.
454
455
transport -- A Transport object, defining how to access files.
456
457
init -- If True, create new control files in a previously
458
unversioned directory. If False, the branch must already
459
be versioned.
460
461
relax_version_check -- If true, the usual check for the branch
462
version is not applied. This is intended only for
463
upgrade/recovery type use; it's not guaranteed that
464
all operations will work on old format branches.
465
466
In the test suite, creation of new trees is tested using the
467
`ScratchBranch` class.
468
"""
469
assert isinstance(transport, Transport), \
470
"%r is not a Transport" % transport
471
# TODO: jam 20060103 We create a clone of this transport at .bzr/
472
# and then we forget about it, should we keep a handle to it?
473
self._base = transport.base
474
self.control_files = LockableFiles(transport.clone(bzrlib.BZRDIR),
475
'branch-lock')
476
if init:
477
self._make_control()
478
self._check_format(relax_version_check)
479
self.repository = Repository(transport, self._branch_format)
480
481
def __str__(self):
482
return '%s(%r)' % (self.__class__.__name__, self.base)
483
484
__repr__ = __str__
485
486
def __del__(self):
487
# TODO: It might be best to do this somewhere else,
488
# but it is nice for a Branch object to automatically
489
# cache it's information.
490
# Alternatively, we could have the Transport objects cache requests
491
# See the earlier discussion about how major objects (like Branch)
492
# should never expect their __del__ function to run.
493
if hasattr(self, 'cache_root') and self.cache_root is not None:
494
try:
495
shutil.rmtree(self.cache_root)
496
except:
497
pass
498
self.cache_root = None
499
500
def _get_base(self):
501
return self._base
502
503
base = property(_get_base, doc="The URL for the root of this branch.")
504
505
def _finish_transaction(self):
506
"""Exit the current transaction."""
507
return self.control_files._finish_transaction()
508
509
def get_transaction(self):
510
"""Return the current active transaction.
511
512
If no transaction is active, this returns a passthrough object
513
for which all data is immediately flushed and no caching happens.
514
"""
515
# this is an explicit function so that we can do tricky stuff
516
# when the storage in rev_storage is elsewhere.
517
# we probably need to hook the two 'lock a location' and
518
# 'have a transaction' together more delicately, so that
519
# we can have two locks (branch and storage) and one transaction
520
# ... and finishing the transaction unlocks both, but unlocking
521
# does not. - RBC 20051121
522
return self.control_files.get_transaction()
523
524
def _set_transaction(self, transaction):
525
"""Set a new active transaction."""
526
return self.control_files._set_transaction(transaction)
527
528
def abspath(self, name):
529
"""See Branch.abspath."""
530
return self.control_files._transport.abspath(name)
531
532
def _make_control(self):
533
from bzrlib.inventory import Inventory
534
from bzrlib.weavefile import write_weave_v5
535
from bzrlib.weave import Weave
536
537
# Create an empty inventory
538
sio = StringIO()
539
# if we want per-tree root ids then this is the place to set
540
# them; they're not needed for now and so ommitted for
541
# simplicity.
542
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
543
empty_inv = sio.getvalue()
544
sio = StringIO()
545
bzrlib.weavefile.write_weave_v5(Weave(), sio)
546
empty_weave = sio.getvalue()
547
548
dirs = ['', 'revision-store', 'weaves']
549
files = [('README',
550
"This is a Bazaar-NG control directory.\n"
551
"Do not change any files in this directory.\n"),
552
('branch-format', BZR_BRANCH_FORMAT_6),
553
('revision-history', ''),
554
('branch-name', ''),
555
('branch-lock', ''),
556
('pending-merges', ''),
557
('inventory', empty_inv),
558
('inventory.weave', empty_weave),
559
('ancestry.weave', empty_weave)
560
]
561
cfe = self.control_files._escape
562
self.control_files._transport.mkdir_multi([cfe(d) for d in dirs],
563
mode=self.control_files._dir_mode)
564
self.control_files.lock_write()
565
try:
566
for file, content in files:
567
self.control_files.put_utf8(file, content)
568
mutter('created control directory in ' + self.base)
569
finally:
570
self.control_files.unlock()
571
572
def _check_format(self, relax_version_check):
573
"""Check this branch format is supported.
574
575
The format level is stored, as an integer, in
576
self._branch_format for code that needs to check it later.
577
578
In the future, we might need different in-memory Branch
579
classes to support downlevel branches. But not yet.
580
"""
581
try:
582
fmt = self.control_files.controlfile('branch-format', 'r').read()
583
except NoSuchFile:
584
raise NotBranchError(path=self.base)
585
mutter("got branch format %r", fmt)
586
if fmt == BZR_BRANCH_FORMAT_6:
587
self._branch_format = 6
588
elif fmt == BZR_BRANCH_FORMAT_5:
589
self._branch_format = 5
590
elif fmt == BZR_BRANCH_FORMAT_4:
591
self._branch_format = 4
592
593
if (not relax_version_check
594
and self._branch_format not in (5, 6)):
595
raise errors.UnsupportedFormatError(
596
'sorry, branch format %r not supported' % fmt,
597
['use a different bzr version',
598
'or remove the .bzr directory'
599
' and "bzr init" again'])
600
601
@needs_read_lock
602
def get_root_id(self):
603
"""See Branch.get_root_id."""
604
inv = self.repository.get_inventory(self.last_revision())
605
return inv.root.file_id
606
607
def lock_write(self):
608
# TODO: test for failed two phase locks. This is known broken.
609
self.control_files.lock_write()
610
self.repository.lock_write()
611
612
def lock_read(self):
613
# TODO: test for failed two phase locks. This is known broken.
614
self.control_files.lock_read()
615
self.repository.lock_read()
616
617
def unlock(self):
618
# TODO: test for failed two phase locks. This is known broken.
619
self.repository.unlock()
620
self.control_files.unlock()
621
622
@needs_read_lock
623
def print_file(self, file, revision_id):
624
"""See Branch.print_file."""
625
return self.repository.print_file(file, revision_id)
626
627
@needs_write_lock
628
def append_revision(self, *revision_ids):
629
"""See Branch.append_revision."""
630
for revision_id in revision_ids:
631
mutter("add {%s} to revision-history" % revision_id)
632
rev_history = self.revision_history()
633
rev_history.extend(revision_ids)
634
self.set_revision_history(rev_history)
635
636
@needs_write_lock
637
def set_revision_history(self, rev_history):
638
"""See Branch.set_revision_history."""
639
old_revision = self.last_revision()
640
new_revision = rev_history[-1]
641
self.control_files.put_utf8(
642
'revision-history', '\n'.join(rev_history))
643
try:
644
# FIXME: RBC 20051207 this smells wrong, last_revision in the
645
# working tree may be != to last_revision in the branch - so
646
# why is this passing in the branches last_revision ?
647
self.working_tree().set_last_revision(new_revision, old_revision)
648
except NoWorkingTree:
649
mutter('Unable to set_last_revision without a working tree.')
650
651
def get_revision_delta(self, revno):
652
"""Return the delta for one revision.
653
654
The delta is relative to its mainline predecessor, or the
655
empty tree for revision 1.
656
"""
657
assert isinstance(revno, int)
658
rh = self.revision_history()
659
if not (1 <= revno <= len(rh)):
660
raise InvalidRevisionNumber(revno)
661
662
# revno is 1-based; list is 0-based
663
664
new_tree = self.repository.revision_tree(rh[revno-1])
665
if revno == 1:
666
old_tree = EmptyTree()
667
else:
668
old_tree = self.repository.revision_tree(rh[revno-2])
669
return compare_trees(old_tree, new_tree)
670
671
@needs_read_lock
672
def revision_history(self):
673
"""See Branch.revision_history."""
674
# FIXME are transactions bound to control files ? RBC 20051121
675
transaction = self.get_transaction()
676
history = transaction.map.find_revision_history()
677
if history is not None:
678
mutter("cache hit for revision-history in %s", self)
679
return list(history)
680
history = [l.rstrip('\r\n') for l in
681
self.control_files.controlfile('revision-history', 'r').readlines()]
682
transaction.map.add_revision_history(history)
683
# this call is disabled because revision_history is
684
# not really an object yet, and the transaction is for objects.
685
# transaction.register_clean(history, precious=True)
686
return list(history)
687
688
def update_revisions(self, other, stop_revision=None):
689
"""See Branch.update_revisions."""
690
from bzrlib.fetch import greedy_fetch
691
if stop_revision is None:
692
stop_revision = other.last_revision()
693
### Should this be checking is_ancestor instead of revision_history?
694
if (stop_revision is not None and
695
stop_revision in self.revision_history()):
696
return
697
greedy_fetch(to_branch=self, from_branch=other,
698
revision=stop_revision)
699
pullable_revs = self.pullable_revisions(other, stop_revision)
700
if len(pullable_revs) > 0:
701
self.append_revision(*pullable_revs)
702
703
def pullable_revisions(self, other, stop_revision):
704
"""See Branch.pullable_revisions."""
705
other_revno = other.revision_id_to_revno(stop_revision)
706
try:
707
return self.missing_revisions(other, other_revno)
708
except DivergedBranches, e:
709
try:
710
pullable_revs = get_intervening_revisions(self.last_revision(),
711
stop_revision,
712
self.repository)
713
assert self.last_revision() not in pullable_revs
714
return pullable_revs
715
except bzrlib.errors.NotAncestor:
716
if is_ancestor(self.last_revision(), stop_revision, self):
717
return []
718
else:
719
raise e
720
721
def basis_tree(self):
722
"""See Branch.basis_tree."""
723
try:
724
revision_id = self.revision_history()[-1]
725
# FIXME: This is an abstraction violation, the basis tree
726
# here as defined is on the working tree, the method should
727
# be too. The basis tree for a branch can be different than
728
# that for a working tree. RBC 20051207
729
xml = self.working_tree().read_basis_inventory(revision_id)
730
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
731
return RevisionTree(self.repository, inv, revision_id)
732
except (IndexError, NoSuchFile, NoWorkingTree), e:
733
return self.repository.revision_tree(self.last_revision())
734
735
def working_tree(self):
736
"""See Branch.working_tree."""
737
from bzrlib.workingtree import WorkingTree
738
if self.base.find('://') != -1:
739
raise NoWorkingTree(self.base)
740
return WorkingTree(self.base, branch=self)
741
742
@needs_write_lock
743
def pull(self, source, overwrite=False):
744
"""See Branch.pull."""
745
source.lock_read()
746
try:
747
old_count = len(self.revision_history())
748
try:
749
self.update_revisions(source)
750
except DivergedBranches:
751
if not overwrite:
752
raise
753
if overwrite:
754
self.set_revision_history(source.revision_history())
755
new_count = len(self.revision_history())
756
return new_count - old_count
757
finally:
758
source.unlock()
759
760
def get_parent(self):
761
"""See Branch.get_parent."""
762
import errno
763
_locs = ['parent', 'pull', 'x-pull']
764
for l in _locs:
765
try:
766
return self.control_files.controlfile(l, 'r').read().strip('\n')
767
except NoSuchFile:
768
pass
769
return None
770
771
def get_push_location(self):
772
"""See Branch.get_push_location."""
773
config = bzrlib.config.BranchConfig(self)
774
push_loc = config.get_user_option('push_location')
775
return push_loc
776
777
def set_push_location(self, location):
778
"""See Branch.set_push_location."""
779
config = bzrlib.config.LocationConfig(self.base)
780
config.set_user_option('push_location', location)
781
782
@needs_write_lock
783
def set_parent(self, url):
784
"""See Branch.set_parent."""
785
# TODO: Maybe delete old location files?
786
from bzrlib.atomicfile import AtomicFile
787
f = AtomicFile(self.control_files.controlfilename('parent'))
788
try:
789
f.write(url + '\n')
790
f.commit()
791
finally:
792
f.close()
793
794
def tree_config(self):
795
return TreeConfig(self)
796
797
def _get_truncated_history(self, revision_id):
798
history = self.revision_history()
799
if revision_id is None:
800
return history
801
try:
802
idx = history.index(revision_id)
803
except ValueError:
804
raise InvalidRevisionId(revision_id=revision, branch=self)
805
return history[:idx+1]
806
807
@needs_read_lock
808
def _clone_weave(self, to_location, revision=None, basis_branch=None):
809
assert isinstance(to_location, basestring)
810
if basis_branch is not None:
811
note("basis_branch is not supported for fast weave copy yet.")
812
813
history = self._get_truncated_history(revision)
814
if not bzrlib.osutils.lexists(to_location):
815
os.mkdir(to_location)
816
branch_to = Branch.initialize(to_location)
817
mutter("copy branch from %s to %s", self, branch_to)
818
branch_to.working_tree().set_root_id(self.get_root_id())
819
820
self.repository.copy(branch_to.repository)
821
822
# must be done *after* history is copied across
823
# FIXME duplicate code with base .clone().
824
# .. would template method be useful here. RBC 20051207
825
branch_to.set_parent(self.base)
826
branch_to.append_revision(*history)
827
# circular import protection
828
from bzrlib.merge import build_working_dir
829
build_working_dir(to_location)
830
mutter("copied")
831
return branch_to
832
833
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
834
if to_branch_type is None:
835
to_branch_type = BzrBranch
836
837
if to_branch_type == BzrBranch \
838
and self.repository.weave_store.listable() \
839
and self.repository.revision_store.listable():
840
return self._clone_weave(to_location, revision, basis_branch)
841
842
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
843
844
845
class ScratchBranch(BzrBranch):
824
"""
825
## TODO: Option to move IDs only
826
assert not isinstance(from_paths, basestring)
827
tree = self.working_tree()
828
inv = tree.inventory
829
to_abs = self.abspath(to_name)
830
if not isdir(to_abs):
831
bailout("destination %r is not a directory" % to_abs)
832
if not tree.has_filename(to_name):
833
bailout("destination %r not in working directory" % to_abs)
834
to_dir_id = inv.path2id(to_name)
835
if to_dir_id == None and to_name != '':
836
bailout("destination %r is not a versioned directory" % to_name)
837
to_dir_ie = inv[to_dir_id]
838
if to_dir_ie.kind not in ('directory', 'root_directory'):
839
bailout("destination %r is not a directory" % to_abs)
840
841
to_idpath = Set(inv.get_idpath(to_dir_id))
842
843
for f in from_paths:
844
if not tree.has_filename(f):
845
bailout("%r does not exist in working tree" % f)
846
f_id = inv.path2id(f)
847
if f_id == None:
848
bailout("%r is not versioned" % f)
849
name_tail = splitpath(f)[-1]
850
dest_path = appendpath(to_name, name_tail)
851
if tree.has_filename(dest_path):
852
bailout("destination %r already exists" % dest_path)
853
if f_id in to_idpath:
854
bailout("can't move %r to a subdirectory of itself" % f)
855
856
# OK, so there's a race here, it's possible that someone will
857
# create a file in this interval and then the rename might be
858
# left half-done. But we should have caught most problems.
859
860
for f in from_paths:
861
name_tail = splitpath(f)[-1]
862
dest_path = appendpath(to_name, name_tail)
863
print "%s => %s" % (f, dest_path)
864
inv.rename(inv.path2id(f), to_dir_id, name_tail)
865
try:
866
os.rename(self.abspath(f), self.abspath(dest_path))
867
except OSError, e:
868
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
869
["rename rolled back"])
870
871
self._write_inventory(inv)
872
873
874
875
def show_status(self, show_all=False):
876
"""Display single-line status for non-ignored working files.
877
878
The list is show sorted in order by file name.
879
880
>>> b = ScratchBranch(files=['foo', 'foo~'])
881
>>> b.show_status()
882
? foo
883
>>> b.add('foo')
884
>>> b.show_status()
885
A foo
886
>>> b.commit("add foo")
887
>>> b.show_status()
888
>>> os.unlink(b.abspath('foo'))
889
>>> b.show_status()
890
D foo
891
892
893
TODO: Get state for single files.
894
895
TODO: Perhaps show a slash at the end of directory names.
896
897
"""
898
899
# We have to build everything into a list first so that it can
900
# sorted by name, incorporating all the different sources.
901
902
# FIXME: Rather than getting things in random order and then sorting,
903
# just step through in order.
904
905
# Interesting case: the old ID for a file has been removed,
906
# but a new file has been created under that name.
907
908
old = self.basis_tree()
909
new = self.working_tree()
910
911
for fs, fid, oldname, newname, kind in diff_trees(old, new):
912
if fs == 'R':
913
show_status(fs, kind,
914
oldname + ' => ' + newname)
915
elif fs == 'A' or fs == 'M':
916
show_status(fs, kind, newname)
917
elif fs == 'D':
918
show_status(fs, kind, oldname)
919
elif fs == '.':
920
if show_all:
921
show_status(fs, kind, newname)
922
elif fs == 'I':
923
if show_all:
924
show_status(fs, kind, newname)
925
elif fs == '?':
926
show_status(fs, kind, newname)
927
else:
928
bailout("weird file state %r" % ((fs, fid),))
929
930
931
932
class ScratchBranch(Branch):
846
933
"""Special test class: a branch that cleans up after itself.
847
934
848
935
>>> b = ScratchBranch()
849
936
>>> isdir(b.base)
850
937
True
851
938
>>> bd = b.base
852
>>> b._transport.__del__()
939
>>> del b
853
940
>>> isdir(bd)
854
941
False
855
942
"""
856
857
def __init__(self, files=[], dirs=[], transport=None):
943
def __init__(self, files=[], dirs=[]):
858
944
"""Make a test branch.
859
945
860
946
This creates a temporary directory and runs init-tree in it.
861
947
862
948
If any files are listed, they are created in the working copy.
863
949
"""
864
if transport is None:
865
transport = bzrlib.transport.local.ScratchTransport()
866
super(ScratchBranch, self).__init__(transport, init=True)
867
else:
868
super(ScratchBranch, self).__init__(transport)
869
870
# BzrBranch creates a clone to .bzr and then forgets about the
871
# original transport. A ScratchTransport() deletes itself and
872
# everything underneath it when it goes away, so we need to
873
# grab a local copy to prevent that from happening
874
self._transport = transport
875
950
Branch.__init__(self, tempfile.mkdtemp(), init=True)
876
951
for d in dirs:
877
self._transport.mkdir(d)
952
os.mkdir(self.abspath(d))
878
953
879
954
for f in files:
880
self._transport.put(f, 'content of %s' % f)
881
882
def clone(self):
883
"""
884
>>> orig = ScratchBranch(files=["file1", "file2"])
885
>>> os.listdir(orig.base)
886
[u'.bzr', u'file1', u'file2']
887
>>> clone = orig.clone()
888
>>> if os.name != 'nt':
889
... os.path.samefile(orig.base, clone.base)
890
... else:
891
... orig.base == clone.base
892
...
893
False
894
>>> os.listdir(clone.base)
895
[u'.bzr', u'file1', u'file2']
896
"""
897
from shutil import copytree
898
from bzrlib.osutils import mkdtemp
899
base = mkdtemp()
900
os.rmdir(base)
901
copytree(self.base, base, symlinks=True)
902
return ScratchBranch(
903
transport=bzrlib.transport.local.ScratchTransport(base))
955
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
956
957
958
def __del__(self):
959
"""Destroy the test branch, removing the scratch directory."""
960
try:
961
shutil.rmtree(self.base)
962
except OSError:
963
# Work around for shutil.rmtree failing on Windows when
964
# readonly files are encountered
965
for root, dirs, files in os.walk(self.base, topdown=False):
966
for name in files:
967
os.chmod(os.path.join(root, name), 0700)
968
shutil.rmtree(self.base)
969
904
970
905
971
906
972
######################################################################
909
975
910
976
def is_control_file(filename):
911
977
## FIXME: better check
912
filename = normpath(filename)
978
filename = os.path.normpath(filename)
913
979
while filename != '':
914
980
head, tail = os.path.split(filename)
915
981
## mutter('check %r for control file' % ((head, tail), ))
919
985
break
920
986
filename = head
921
987
return False
988
989
990
991
def _gen_revision_id(when):
992
"""Return new revision-id."""
993
s = '%s-%s-' % (user_email(), compact_date(when))
994
s += hexlify(rand_bytes(8))
995
return s
996
997
998
def gen_file_id(name):
999
"""Return new file id.
1000
1001
This should probably generate proper UUIDs, but for the moment we
1002
cope with just randomness because running uuidgen every time is
1003
slow."""
1004
idx = name.rfind('/')
1005
if idx != -1:
1006
name = name[idx+1 : ]
1007
1008
name = name.lstrip('.')
1009
1010
s = hexlify(rand_bytes(8))
1011
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1