« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1608.2.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1608.2.1
- Committer: Martin Pool
- Date: 2006-04-04 10:20:54 UTC
- mfrom: (1185.80.10 bzr-escape-stores)
- mto: (1651.1.1 bzr.merge.escaped-stores)
- mto: This revision was merged to the branch mainline in revision 1657.
- Revision ID: mbp@sourcefrog.net-20060404102054-77707fa58447e26a
[merge] Storage filename escaping
- files added:
- .rsyncexclude
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- tools
- tools/doc_generate
- files removed:
- bzrlib/tests.py
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
from sets import Set
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
18
from copy import deepcopy
19
from cStringIO import StringIO
20
import errno
21
import os
22
import shutil
23
import sys
24
from unittest import TestSuite
25
from warnings import warn
23
26
24
27
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"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
40
41
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
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
37
UnlistableStore,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
39
NoWorkingTree)
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
47
safe_unicode,
48
)
49
from bzrlib.textui import show_status
50
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
55
is_ancestor,
56
NULL_REVISION,
57
Revision,
58
)
59
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
64
import bzrlib.ui
65
import bzrlib.xml5
66
67
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
72
73
# TODO: Maybe include checks for common corruption of newlines, etc?
74
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
69
80
70
81
71
82
######################################################################
72
83
# branch objects
73
84
74
class Branch:
85
class Branch(object):
75
86
"""Branch holding a history of revisions.
76
87
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.
88
base
89
Base directory/url of the branch.
89
90
"""
90
def __init__(self, base, init=False, find_root=True):
91
"""Create new branch object at a particular location.
92
93
:param base: Base directory for the branch.
94
95
:param init: If True, create new control files in a previously
96
unversioned directory. If False, the branch must already
97
be versioned.
98
99
:param find_root: If true and init is false, find the root of the
100
existing branch containing base.
101
102
In the test suite, creation of new trees is tested using the
103
`ScratchBranch` class.
104
"""
105
if init:
106
self.base = os.path.realpath(base)
107
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
122
123
def __str__(self):
124
return '%s(%r)' % (self.__class__.__name__, self.base)
125
126
127
__repr__ = __str__
128
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
93
base = None
94
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
97
98
@staticmethod
99
@deprecated_method(zero_eight)
100
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
103
104
@staticmethod
105
def open(base, _unsupported=False):
106
"""Open the repository rooted at base.
107
108
For instance, if the repository is at URL/.bzr/repository,
109
Repository.open(URL) -> a Repository instance.
110
"""
111
control = bzrdir.BzrDir.open(base, _unsupported)
112
return control.open_branch(_unsupported)
113
114
@staticmethod
115
def open_containing(url):
116
"""Open an existing branch which contains url.
117
118
This probes for a branch at url, and searches upwards from there.
119
120
Basically we keep looking up until we find the control directory or
121
run into the root. If there isn't one, raises NotBranchError.
122
If there is one and it is either an unrecognised format or an unsupported
123
format, UnknownFormatError or UnsupportedFormatError are raised.
124
If there is one, it is returned, along with the unused portion of url.
125
"""
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
128
129
@staticmethod
130
@deprecated_function(zero_eight)
131
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
133
134
NOTE: This will soon be deprecated in favour of creation
135
through a BzrDir.
136
"""
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
138
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
142
"""
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
146
147
def _get_nick(self):
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
150
151
def _set_nick(self, nick):
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
155
156
nick = property(_get_nick, _set_nick)
157
158
def lock_write(self):
159
raise NotImplementedError('lock_write is abstract')
160
161
def lock_read(self):
162
raise NotImplementedError('lock_read is abstract')
163
164
def unlock(self):
165
raise NotImplementedError('unlock is abstract')
166
167
def peek_lock_mode(self):
168
"""Return lock mode for the Branch: 'r', 'w' or None"""
169
raise NotImplementedError(self.peek_lock_mode)
129
170
130
171
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
147
148
def controlfilename(self, file_or_path):
149
"""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)
153
154
155
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
159
160
def _make_control(self):
161
os.mkdir(self.controlfilename([]))
162
self.controlfile('README', 'w').write(
163
"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):
176
"""Check this branch format is supported.
177
178
The current tool only supports the current unstable format.
179
180
In the future, we might need different in-memory Branch
181
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
190
191
def read_working_inventory(self):
192
"""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
199
200
def _write_inventory(self, inv):
201
"""Update the working inventory.
202
203
That is to say, the inventory describing changes underway, that
204
will be committed to the next revision.
205
"""
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'))
213
mutter('wrote working inventory')
214
215
216
inventory = property(read_working_inventory, _write_inventory, None,
217
"""Inventory for the working copy.""")
218
219
220
def add(self, files, verbose=False):
221
"""Make files versioned.
222
223
This puts the files in the Added state, so that they will be
224
recorded by the next commit.
225
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', [])
259
"""
260
261
# TODO: Re-adding a file that is removed in the working copy
262
# should probably put it back with the previous ID.
263
if isinstance(files, types.StringTypes):
264
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
297
298
299
def remove(self, files, verbose=False):
300
"""Mark nominated files for removal from the inventory.
301
302
This does not remove their text. This does not run on
303
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
331
removing may be useful and the user can just use use rm, and
332
is the opposite of add. Removing it is consistent with most
333
other tools. Maybe an option.
334
"""
335
## TODO: Normalize names
336
## TODO: Remove nested loops; better scalability
337
338
if isinstance(files, types.StringTypes):
339
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
359
self._write_inventory(inv)
360
361
362
def unknowns(self):
363
"""Return all unknown files.
364
365
These are files in the working directory that are not versioned or
366
control files or ignored.
367
368
>>> b = ScratchBranch(files=['foo', 'foo~'])
369
>>> list(b.unknowns())
370
['foo']
371
>>> b.add('foo')
372
>>> list(b.unknowns())
373
[]
374
>>> b.remove('foo')
375
>>> list(b.unknowns())
376
['foo']
377
"""
378
return self.working_tree().unknowns()
379
380
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())
551
552
553
def get_revision(self, revision_id):
554
"""Return the Revision object for a named revision"""
555
r = Revision.read_xml(self.revision_store[revision_id])
556
assert r.revision_id == revision_id
557
return r
558
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
569
570
def get_revision_inventory(self, revision_id):
571
"""Return inventory of a past revision."""
572
if revision_id == None:
573
return Inventory()
172
"""Return absolute filename for something in the branch
173
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
176
"""
177
raise NotImplementedError('abspath is abstract')
178
179
def bind(self, other):
180
"""Bind the local branch the other branch.
181
182
:param other: The branch to bind to
183
:type other: Branch
184
"""
185
raise errors.UpgradeRequired(self.base)
186
187
@needs_write_lock
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
190
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
193
of the branch.
194
:param pb: An optional progress bar to use.
195
196
Returns the copied revision count and the failed revisions in a tuple:
197
(copied, failures).
198
"""
199
if self.base == from_branch.base:
200
raise Exception("can't fetch from a branch to itself %s, %s" %
201
(self.base, to_branch.base))
202
if pb is None:
203
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
204
pb = nested_pb
574
205
else:
575
return self.get_inventory(self.get_revision(revision_id).inventory_id)
576
206
nested_pb = None
207
208
from_branch.lock_read()
209
try:
210
if last_revision is None:
211
pb.update('get source history')
212
from_history = from_branch.revision_history()
213
if from_history:
214
last_revision = from_history[-1]
215
else:
216
# no history in the source branch
217
last_revision = NULL_REVISION
218
return self.repository.fetch(from_branch.repository,
219
revision_id=last_revision,
220
pb=nested_pb)
221
finally:
222
if nested_pb is not None:
223
nested_pb.finished()
224
from_branch.unlock()
225
226
def get_bound_location(self):
227
"""Return the URL of the rbanch we are bound to.
228
229
Older format branches cannot bind, please be sure to use a metadir
230
branch.
231
"""
232
return None
233
234
def get_master_branch(self):
235
"""Return the branch we are bound to.
236
237
:return: Either a Branch, or None
238
"""
239
return None
240
241
def get_root_id(self):
242
"""Return the id of this branches root"""
243
raise NotImplementedError('get_root_id is abstract')
244
245
def print_file(self, file, revision_id):
246
"""Print `file` to stdout."""
247
raise NotImplementedError('print_file is abstract')
248
249
def append_revision(self, *revision_ids):
250
raise NotImplementedError('append_revision is abstract')
251
252
def set_revision_history(self, rev_history):
253
raise NotImplementedError('set_revision_history is abstract')
577
254
578
255
def revision_history(self):
579
"""Return sequence of revision hashes on to this branch.
580
581
>>> ScratchBranch().revision_history()
582
[]
583
"""
584
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
585
256
"""Return sequence of revision hashes on to this branch."""
257
raise NotImplementedError('revision_history is abstract')
586
258
587
259
def revno(self):
588
260
"""Return current revision number for this branch.
589
261
590
262
That is equivalent to the number of revisions committed to
591
263
this branch.
592
593
>>> b = ScratchBranch()
594
>>> b.revno()
595
0
596
>>> b.commit('no foo')
597
>>> b.revno()
598
1
599
264
"""
600
265
return len(self.revision_history())
601
266
602
603
def last_patch(self):
604
"""Return last patch hash, or None if no history.
605
606
>>> ScratchBranch().last_patch() == None
607
True
608
"""
267
def unbind(self):
268
"""Older format branches cannot bind or unbind."""
269
raise errors.UpgradeRequired(self.base)
270
271
def last_revision(self):
272
"""Return last patch hash, or None if no history."""
609
273
ph = self.revision_history()
610
274
if ph:
611
275
return ph[-1]
612
613
614
def lookup_revision(self, revno):
615
"""Return revision hash for revision number."""
276
else:
277
return None
278
279
def missing_revisions(self, other, stop_revision=None):
280
"""Return a list of new revisions that would perfectly fit.
281
282
If self and other have not diverged, return a list of the revisions
283
present in other, but missing from self.
284
285
>>> from bzrlib.workingtree import WorkingTree
286
>>> bzrlib.trace.silent = True
287
>>> d1 = bzrdir.ScratchDir()
288
>>> br1 = d1.open_branch()
289
>>> wt1 = d1.open_workingtree()
290
>>> d2 = bzrdir.ScratchDir()
291
>>> br2 = d2.open_branch()
292
>>> wt2 = d2.open_workingtree()
293
>>> br1.missing_revisions(br2)
294
[]
295
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
296
>>> br1.missing_revisions(br2)
297
[u'REVISION-ID-1']
298
>>> br2.missing_revisions(br1)
299
[]
300
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
301
>>> br1.missing_revisions(br2)
302
[]
303
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
304
>>> br1.missing_revisions(br2)
305
[u'REVISION-ID-2A']
306
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
307
>>> br1.missing_revisions(br2)
308
Traceback (most recent call last):
309
DivergedBranches: These branches have diverged. Try merge.
310
"""
311
self_history = self.revision_history()
312
self_len = len(self_history)
313
other_history = other.revision_history()
314
other_len = len(other_history)
315
common_index = min(self_len, other_len) -1
316
if common_index >= 0 and \
317
self_history[common_index] != other_history[common_index]:
318
raise DivergedBranches(self, other)
319
320
if stop_revision is None:
321
stop_revision = other_len
322
else:
323
assert isinstance(stop_revision, int)
324
if stop_revision > other_len:
325
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
326
return other_history[self_len:stop_revision]
327
328
def update_revisions(self, other, stop_revision=None):
329
"""Pull in new perfect-fit revisions.
330
331
:param other: Another Branch to pull from
332
:param stop_revision: Updated until the given revision
333
:return: None
334
"""
335
raise NotImplementedError('update_revisions is abstract')
336
337
def pullable_revisions(self, other, stop_revision):
338
raise NotImplementedError('pullable_revisions is abstract')
339
340
def revision_id_to_revno(self, revision_id):
341
"""Given a revision id, return its revno"""
342
if revision_id is None:
343
return 0
344
history = self.revision_history()
345
try:
346
return history.index(revision_id) + 1
347
except ValueError:
348
raise bzrlib.errors.NoSuchRevision(self, revision_id)
349
350
def get_rev_id(self, revno, history=None):
351
"""Find the revision id of the specified revno."""
616
352
if revno == 0:
617
353
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
625
626
def revision_tree(self, revision_id):
627
"""Return Tree for a revision on this branch.
628
629
`revision_id` may be None for the null revision, in which case
630
an `EmptyTree` is returned."""
631
632
if revision_id == None:
633
return EmptyTree()
634
else:
635
inv = self.get_revision_inventory(revision_id)
636
return RevisionTree(self.text_store, inv)
637
638
639
def working_tree(self):
640
"""Return a `Tree` for the working copy."""
641
return WorkingTree(self.base, self.read_working_inventory())
642
354
if history is None:
355
history = self.revision_history()
356
elif revno <= 0 or revno > len(history):
357
raise bzrlib.errors.NoSuchRevision(self, revno)
358
return history[revno - 1]
359
360
def pull(self, source, overwrite=False, stop_revision=None):
361
raise NotImplementedError('pull is abstract')
643
362
644
363
def basis_tree(self):
645
364
"""Return `Tree` object for last revision.
646
365
647
366
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):
760
"""Special test class: a branch that cleans up after itself.
761
762
>>> b = ScratchBranch()
763
>>> isdir(b.base)
764
True
765
>>> bd = b.base
766
>>> del b
767
>>> isdir(bd)
768
False
769
"""
770
def __init__(self, files=[], dirs=[]):
771
"""Make a test branch.
772
773
This creates a temporary directory and runs init-tree in it.
774
775
If any files are listed, they are created in the working copy.
776
"""
777
Branch.__init__(self, tempfile.mkdtemp(), init=True)
778
for d in dirs:
779
os.mkdir(self.abspath(d))
367
"""
368
return self.repository.revision_tree(self.last_revision())
369
370
def rename_one(self, from_rel, to_rel):
371
"""Rename one file.
372
373
This can change the directory or the filename or both.
374
"""
375
raise NotImplementedError('rename_one is abstract')
376
377
def move(self, from_paths, to_name):
378
"""Rename files.
379
380
to_name must exist as a versioned directory.
381
382
If to_name exists and is a directory, the files are moved into
383
it, keeping their old names. If it is a directory,
384
385
Note that to_name is only the last component of the new name;
386
this doesn't change the directory.
387
388
This returns a list of (from_path, to_path) pairs for each
389
entry that is moved.
390
"""
391
raise NotImplementedError('move is abstract')
392
393
def get_parent(self):
394
"""Return the parent location of the branch.
395
396
This is the default location for push/pull/missing. The usual
397
pattern is that the user can override it by specifying a
398
location.
399
"""
400
raise NotImplementedError('get_parent is abstract')
401
402
def get_push_location(self):
403
"""Return the None or the location to push this branch to."""
404
raise NotImplementedError('get_push_location is abstract')
405
406
def set_push_location(self, location):
407
"""Set a new push location for this branch."""
408
raise NotImplementedError('set_push_location is abstract')
409
410
def set_parent(self, url):
411
raise NotImplementedError('set_parent is abstract')
412
413
@needs_write_lock
414
def update(self):
415
"""Synchronise this branch with the master branch if any.
416
417
:return: None or the last_revision pivoted out during the update.
418
"""
419
return None
420
421
def check_revno(self, revno):
422
"""\
423
Check whether a revno corresponds to any revision.
424
Zero (the NULL revision) is considered valid.
425
"""
426
if revno != 0:
427
self.check_real_revno(revno)
780
428
781
for f in files:
782
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
783
429
def check_real_revno(self, revno):
430
"""\
431
Check whether a revno corresponds to a real revision.
432
Zero (the NULL revision) is considered invalid
433
"""
434
if revno < 1 or revno > self.revno():
435
raise InvalidRevisionNumber(revno)
436
437
@needs_read_lock
438
def clone(self, *args, **kwargs):
439
"""Clone this branch into to_bzrdir preserving all semantic values.
440
441
revision_id: if not None, the revision history in the new branch will
442
be truncated to end with revision_id.
443
"""
444
# for API compatability, until 0.8 releases we provide the old api:
445
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
446
# after 0.8 releases, the *args and **kwargs should be changed:
447
# def clone(self, to_bzrdir, revision_id=None):
448
if (kwargs.get('to_location', None) or
449
kwargs.get('revision', None) or
450
kwargs.get('basis_branch', None) or
451
(len(args) and isinstance(args[0], basestring))):
452
# backwards compatability api:
453
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
454
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
455
# get basis_branch
456
if len(args) > 2:
457
basis_branch = args[2]
458
else:
459
basis_branch = kwargs.get('basis_branch', None)
460
if basis_branch:
461
basis = basis_branch.bzrdir
462
else:
463
basis = None
464
# get revision
465
if len(args) > 1:
466
revision_id = args[1]
467
else:
468
revision_id = kwargs.get('revision', None)
469
# get location
470
if len(args):
471
url = args[0]
472
else:
473
# no default to raise if not provided.
474
url = kwargs.get('to_location')
475
return self.bzrdir.clone(url,
476
revision_id=revision_id,
477
basis=basis).open_branch()
478
# new cleaner api.
479
# generate args by hand
480
if len(args) > 1:
481
revision_id = args[1]
482
else:
483
revision_id = kwargs.get('revision_id', None)
484
if len(args):
485
to_bzrdir = args[0]
486
else:
487
# no default to raise if not provided.
488
to_bzrdir = kwargs.get('to_bzrdir')
489
result = self._format.initialize(to_bzrdir)
490
self.copy_content_into(result, revision_id=revision_id)
491
return result
492
493
@needs_read_lock
494
def sprout(self, to_bzrdir, revision_id=None):
495
"""Create a new line of development from the branch, into to_bzrdir.
496
497
revision_id: if not None, the revision history in the new branch will
498
be truncated to end with revision_id.
499
"""
500
result = self._format.initialize(to_bzrdir)
501
self.copy_content_into(result, revision_id=revision_id)
502
result.set_parent(self.bzrdir.root_transport.base)
503
return result
504
505
@needs_read_lock
506
def copy_content_into(self, destination, revision_id=None):
507
"""Copy the content of self into destination.
508
509
revision_id: if not None, the revision history in the new branch will
510
be truncated to end with revision_id.
511
"""
512
new_history = self.revision_history()
513
if revision_id is not None:
514
try:
515
new_history = new_history[:new_history.index(revision_id) + 1]
516
except ValueError:
517
rev = self.repository.get_revision(revision_id)
518
new_history = rev.get_history(self.repository)[1:]
519
destination.set_revision_history(new_history)
520
parent = self.get_parent()
521
if parent:
522
destination.set_parent(parent)
523
524
525
class BranchFormat(object):
526
"""An encapsulation of the initialization and open routines for a format.
527
528
Formats provide three things:
529
* An initialization routine,
530
* a format string,
531
* an open routine.
532
533
Formats are placed in an dict by their format string for reference
534
during branch opening. Its not required that these be instances, they
535
can be classes themselves with class methods - it simply depends on
536
whether state is needed for a given format or not.
537
538
Once a format is deprecated, just deprecate the initialize and open
539
methods on the format class. Do not deprecate the object, as the
540
object will be created every time regardless.
541
"""
542
543
_default_format = None
544
"""The default format used for new branches."""
545
546
_formats = {}
547
"""The known formats."""
548
549
@classmethod
550
def find_format(klass, a_bzrdir):
551
"""Return the format for the branch object in a_bzrdir."""
552
try:
553
transport = a_bzrdir.get_branch_transport(None)
554
format_string = transport.get("format").read()
555
return klass._formats[format_string]
556
except NoSuchFile:
557
raise NotBranchError(path=transport.base)
558
except KeyError:
559
raise errors.UnknownFormatError(format_string)
560
561
@classmethod
562
def get_default_format(klass):
563
"""Return the current default format."""
564
return klass._default_format
565
566
def get_format_string(self):
567
"""Return the ASCII format string that identifies this format."""
568
raise NotImplementedError(self.get_format_string)
569
570
def initialize(self, a_bzrdir):
571
"""Create a branch of this format in a_bzrdir."""
572
raise NotImplementedError(self.initialized)
573
574
def is_supported(self):
575
"""Is this format supported?
576
577
Supported formats can be initialized and opened.
578
Unsupported formats may not support initialization or committing or
579
some other features depending on the reason for not being supported.
580
"""
581
return True
582
583
def open(self, a_bzrdir, _found=False):
584
"""Return the branch object for a_bzrdir
585
586
_found is a private parameter, do not use it. It is used to indicate
587
if format probing has already be done.
588
"""
589
raise NotImplementedError(self.open)
590
591
@classmethod
592
def register_format(klass, format):
593
klass._formats[format.get_format_string()] = format
594
595
@classmethod
596
def set_default_format(klass, format):
597
klass._default_format = format
598
599
@classmethod
600
def unregister_format(klass, format):
601
assert klass._formats[format.get_format_string()] is format
602
del klass._formats[format.get_format_string()]
603
604
605
class BzrBranchFormat4(BranchFormat):
606
"""Bzr branch format 4.
607
608
This format has:
609
- a revision-history file.
610
- a branch-lock lock file [ to be shared with the bzrdir ]
611
"""
612
613
def initialize(self, a_bzrdir):
614
"""Create a branch of this format in a_bzrdir."""
615
mutter('creating branch in %s', a_bzrdir.transport.base)
616
branch_transport = a_bzrdir.get_branch_transport(self)
617
utf8_files = [('revision-history', ''),
618
('branch-name', ''),
619
]
620
control_files = LockableFiles(branch_transport, 'branch-lock',
621
TransportLock)
622
control_files.create_lock()
623
control_files.lock_write()
624
try:
625
for file, content in utf8_files:
626
control_files.put_utf8(file, content)
627
finally:
628
control_files.unlock()
629
return self.open(a_bzrdir, _found=True)
630
631
def __init__(self):
632
super(BzrBranchFormat4, self).__init__()
633
self._matchingbzrdir = bzrdir.BzrDirFormat6()
634
635
def open(self, a_bzrdir, _found=False):
636
"""Return the branch object for a_bzrdir
637
638
_found is a private parameter, do not use it. It is used to indicate
639
if format probing has already be done.
640
"""
641
if not _found:
642
# we are being called directly and must probe.
643
raise NotImplementedError
644
return BzrBranch(_format=self,
645
_control_files=a_bzrdir._control_files,
646
a_bzrdir=a_bzrdir,
647
_repository=a_bzrdir.open_repository())
648
649
650
class BzrBranchFormat5(BranchFormat):
651
"""Bzr branch format 5.
652
653
This format has:
654
- a revision-history file.
655
- a format string
656
- a lock dir guarding the branch itself
657
- all of this stored in a branch/ subdirectory
658
- works with shared repositories.
659
660
This format is new in bzr 0.8.
661
"""
662
663
def get_format_string(self):
664
"""See BranchFormat.get_format_string()."""
665
return "Bazaar-NG branch format 5\n"
666
667
def initialize(self, a_bzrdir):
668
"""Create a branch of this format in a_bzrdir."""
669
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
670
branch_transport = a_bzrdir.get_branch_transport(self)
671
utf8_files = [('revision-history', ''),
672
('branch-name', ''),
673
]
674
control_files = LockableFiles(branch_transport, 'lock', LockDir)
675
control_files.create_lock()
676
control_files.lock_write()
677
control_files.put_utf8('format', self.get_format_string())
678
try:
679
for file, content in utf8_files:
680
control_files.put_utf8(file, content)
681
finally:
682
control_files.unlock()
683
return self.open(a_bzrdir, _found=True, )
684
685
def __init__(self):
686
super(BzrBranchFormat5, self).__init__()
687
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
688
689
def open(self, a_bzrdir, _found=False):
690
"""Return the branch object for a_bzrdir
691
692
_found is a private parameter, do not use it. It is used to indicate
693
if format probing has already be done.
694
"""
695
if not _found:
696
format = BranchFormat.find_format(a_bzrdir)
697
assert format.__class__ == self.__class__
698
transport = a_bzrdir.get_branch_transport(None)
699
control_files = LockableFiles(transport, 'lock', LockDir)
700
return BzrBranch5(_format=self,
701
_control_files=control_files,
702
a_bzrdir=a_bzrdir,
703
_repository=a_bzrdir.find_repository())
704
705
def __str__(self):
706
return "Bazaar-NG Metadir branch format 5"
707
708
709
class BranchReferenceFormat(BranchFormat):
710
"""Bzr branch reference format.
711
712
Branch references are used in implementing checkouts, they
713
act as an alias to the real branch which is at some other url.
714
715
This format has:
716
- A location file
717
- a format string
718
"""
719
720
def get_format_string(self):
721
"""See BranchFormat.get_format_string()."""
722
return "Bazaar-NG Branch Reference Format 1\n"
723
724
def initialize(self, a_bzrdir, target_branch=None):
725
"""Create a branch of this format in a_bzrdir."""
726
if target_branch is None:
727
# this format does not implement branch itself, thus the implicit
728
# creation contract must see it as uninitializable
729
raise errors.UninitializableFormat(self)
730
mutter('creating branch reference in %s', a_bzrdir.transport.base)
731
branch_transport = a_bzrdir.get_branch_transport(self)
732
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
733
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
734
branch_transport.put('format', StringIO(self.get_format_string()))
735
return self.open(a_bzrdir, _found=True)
736
737
def __init__(self):
738
super(BranchReferenceFormat, self).__init__()
739
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
740
741
def _make_reference_clone_function(format, a_branch):
742
"""Create a clone() routine for a branch dynamically."""
743
def clone(to_bzrdir, revision_id=None):
744
"""See Branch.clone()."""
745
return format.initialize(to_bzrdir, a_branch)
746
# cannot obey revision_id limits when cloning a reference ...
747
# FIXME RBC 20060210 either nuke revision_id for clone, or
748
# emit some sort of warning/error to the caller ?!
749
return clone
750
751
def open(self, a_bzrdir, _found=False):
752
"""Return the branch that the branch reference in a_bzrdir points at.
753
754
_found is a private parameter, do not use it. It is used to indicate
755
if format probing has already be done.
756
"""
757
if not _found:
758
format = BranchFormat.find_format(a_bzrdir)
759
assert format.__class__ == self.__class__
760
transport = a_bzrdir.get_branch_transport(None)
761
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
762
result = real_bzrdir.open_branch()
763
# this changes the behaviour of result.clone to create a new reference
764
# rather than a copy of the content of the branch.
765
# I did not use a proxy object because that needs much more extensive
766
# testing, and we are only changing one behaviour at the moment.
767
# If we decide to alter more behaviours - i.e. the implicit nickname
768
# then this should be refactored to introduce a tested proxy branch
769
# and a subclass of that for use in overriding clone() and ....
770
# - RBC 20060210
771
result.clone = self._make_reference_clone_function(result)
772
return result
773
774
775
# formats which have no format string are not discoverable
776
# and not independently creatable, so are not registered.
777
__default_format = BzrBranchFormat5()
778
BranchFormat.register_format(__default_format)
779
BranchFormat.register_format(BranchReferenceFormat())
780
BranchFormat.set_default_format(__default_format)
781
_legacy_formats = [BzrBranchFormat4(),
782
]
783
784
class BzrBranch(Branch):
785
"""A branch stored in the actual filesystem.
786
787
Note that it's "local" in the context of the filesystem; it doesn't
788
really matter if it's on an nfs/smb/afs/coda/... share, as long as
789
it's writable, and can be accessed via the normal filesystem API.
790
"""
791
792
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
793
relax_version_check=DEPRECATED_PARAMETER, _format=None,
794
_control_files=None, a_bzrdir=None, _repository=None):
795
"""Create new branch object at a particular location.
796
797
transport -- A Transport object, defining how to access files.
798
799
init -- If True, create new control files in a previously
800
unversioned directory. If False, the branch must already
801
be versioned.
802
803
relax_version_check -- If true, the usual check for the branch
804
version is not applied. This is intended only for
805
upgrade/recovery type use; it's not guaranteed that
806
all operations will work on old format branches.
807
"""
808
if a_bzrdir is None:
809
self.bzrdir = bzrdir.BzrDir.open(transport.base)
810
else:
811
self.bzrdir = a_bzrdir
812
self._transport = self.bzrdir.transport.clone('..')
813
self._base = self._transport.base
814
self._format = _format
815
if _control_files is None:
816
raise BzrBadParameterMissing('_control_files')
817
self.control_files = _control_files
818
if deprecated_passed(init):
819
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
820
"deprecated as of bzr 0.8. Please use Branch.create().",
821
DeprecationWarning,
822
stacklevel=2)
823
if init:
824
# this is slower than before deprecation, oh well never mind.
825
# -> its deprecated.
826
self._initialize(transport.base)
827
self._check_format(_format)
828
if deprecated_passed(relax_version_check):
829
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
830
"relax_version_check parameter is deprecated as of bzr 0.8. "
831
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
832
"open() method.",
833
DeprecationWarning,
834
stacklevel=2)
835
if (not relax_version_check
836
and not self._format.is_supported()):
837
raise errors.UnsupportedFormatError(
838
'sorry, branch format %r not supported' % fmt,
839
['use a different bzr version',
840
'or remove the .bzr directory'
841
' and "bzr init" again'])
842
if deprecated_passed(transport):
843
warn("BzrBranch.__init__(transport=XXX...): The transport "
844
"parameter is deprecated as of bzr 0.8. "
845
"Please use Branch.open, or bzrdir.open_branch().",
846
DeprecationWarning,
847
stacklevel=2)
848
self.repository = _repository
849
850
def __str__(self):
851
return '%s(%r)' % (self.__class__.__name__, self.base)
852
853
__repr__ = __str__
784
854
785
855
def __del__(self):
786
"""Destroy the test branch, removing the scratch directory."""
787
shutil.rmtree(self.base)
788
856
# TODO: It might be best to do this somewhere else,
857
# but it is nice for a Branch object to automatically
858
# cache it's information.
859
# Alternatively, we could have the Transport objects cache requests
860
# See the earlier discussion about how major objects (like Branch)
861
# should never expect their __del__ function to run.
862
# XXX: cache_root seems to be unused, 2006-01-13 mbp
863
if hasattr(self, 'cache_root') and self.cache_root is not None:
864
try:
865
shutil.rmtree(self.cache_root)
866
except:
867
pass
868
self.cache_root = None
869
870
def _get_base(self):
871
return self._base
872
873
base = property(_get_base, doc="The URL for the root of this branch.")
874
875
def _finish_transaction(self):
876
"""Exit the current transaction."""
877
return self.control_files._finish_transaction()
878
879
def get_transaction(self):
880
"""Return the current active transaction.
881
882
If no transaction is active, this returns a passthrough object
883
for which all data is immediately flushed and no caching happens.
884
"""
885
# this is an explicit function so that we can do tricky stuff
886
# when the storage in rev_storage is elsewhere.
887
# we probably need to hook the two 'lock a location' and
888
# 'have a transaction' together more delicately, so that
889
# we can have two locks (branch and storage) and one transaction
890
# ... and finishing the transaction unlocks both, but unlocking
891
# does not. - RBC 20051121
892
return self.control_files.get_transaction()
893
894
def _set_transaction(self, transaction):
895
"""Set a new active transaction."""
896
return self.control_files._set_transaction(transaction)
897
898
def abspath(self, name):
899
"""See Branch.abspath."""
900
return self.control_files._transport.abspath(name)
901
902
def _check_format(self, format):
903
"""Identify the branch format if needed.
904
905
The format is stored as a reference to the format object in
906
self._format for code that needs to check it later.
907
908
The format parameter is either None or the branch format class
909
used to open this branch.
910
911
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
912
"""
913
if format is None:
914
format = BzrBranchFormat.find_format(self.bzrdir)
915
self._format = format
916
mutter("got branch format %s", self._format)
917
918
@needs_read_lock
919
def get_root_id(self):
920
"""See Branch.get_root_id."""
921
tree = self.repository.revision_tree(self.last_revision())
922
return tree.inventory.root.file_id
923
924
def lock_write(self):
925
# TODO: test for failed two phase locks. This is known broken.
926
self.control_files.lock_write()
927
self.repository.lock_write()
928
929
def lock_read(self):
930
# TODO: test for failed two phase locks. This is known broken.
931
self.control_files.lock_read()
932
self.repository.lock_read()
933
934
def unlock(self):
935
# TODO: test for failed two phase locks. This is known broken.
936
self.repository.unlock()
937
self.control_files.unlock()
938
939
def peek_lock_mode(self):
940
if self.control_files._lock_count == 0:
941
return None
942
else:
943
return self.control_files._lock_mode
944
945
@needs_read_lock
946
def print_file(self, file, revision_id):
947
"""See Branch.print_file."""
948
return self.repository.print_file(file, revision_id)
949
950
@needs_write_lock
951
def append_revision(self, *revision_ids):
952
"""See Branch.append_revision."""
953
for revision_id in revision_ids:
954
mutter("add {%s} to revision-history" % revision_id)
955
rev_history = self.revision_history()
956
rev_history.extend(revision_ids)
957
self.set_revision_history(rev_history)
958
959
@needs_write_lock
960
def set_revision_history(self, rev_history):
961
"""See Branch.set_revision_history."""
962
self.control_files.put_utf8(
963
'revision-history', '\n'.join(rev_history))
964
transaction = self.get_transaction()
965
history = transaction.map.find_revision_history()
966
if history is not None:
967
# update the revision history in the identity map.
968
history[:] = list(rev_history)
969
# this call is disabled because revision_history is
970
# not really an object yet, and the transaction is for objects.
971
# transaction.register_dirty(history)
972
else:
973
transaction.map.add_revision_history(rev_history)
974
# this call is disabled because revision_history is
975
# not really an object yet, and the transaction is for objects.
976
# transaction.register_clean(history)
977
978
def get_revision_delta(self, revno):
979
"""Return the delta for one revision.
980
981
The delta is relative to its mainline predecessor, or the
982
empty tree for revision 1.
983
"""
984
assert isinstance(revno, int)
985
rh = self.revision_history()
986
if not (1 <= revno <= len(rh)):
987
raise InvalidRevisionNumber(revno)
988
989
# revno is 1-based; list is 0-based
990
991
new_tree = self.repository.revision_tree(rh[revno-1])
992
if revno == 1:
993
old_tree = EmptyTree()
994
else:
995
old_tree = self.repository.revision_tree(rh[revno-2])
996
return compare_trees(old_tree, new_tree)
997
998
@needs_read_lock
999
def revision_history(self):
1000
"""See Branch.revision_history."""
1001
transaction = self.get_transaction()
1002
history = transaction.map.find_revision_history()
1003
if history is not None:
1004
mutter("cache hit for revision-history in %s", self)
1005
return list(history)
1006
history = [l.rstrip('\r\n') for l in
1007
self.control_files.get_utf8('revision-history').readlines()]
1008
transaction.map.add_revision_history(history)
1009
# this call is disabled because revision_history is
1010
# not really an object yet, and the transaction is for objects.
1011
# transaction.register_clean(history, precious=True)
1012
return list(history)
1013
1014
def update_revisions(self, other, stop_revision=None):
1015
"""See Branch.update_revisions."""
1016
if stop_revision is None:
1017
stop_revision = other.last_revision()
1018
### Should this be checking is_ancestor instead of revision_history?
1019
if (stop_revision is not None and
1020
stop_revision in self.revision_history()):
1021
return
1022
self.fetch(other, stop_revision)
1023
pullable_revs = self.pullable_revisions(other, stop_revision)
1024
if len(pullable_revs) > 0:
1025
self.append_revision(*pullable_revs)
1026
1027
def pullable_revisions(self, other, stop_revision):
1028
other_revno = other.revision_id_to_revno(stop_revision)
1029
try:
1030
return self.missing_revisions(other, other_revno)
1031
except DivergedBranches, e:
1032
try:
1033
pullable_revs = get_intervening_revisions(self.last_revision(),
1034
stop_revision,
1035
self.repository)
1036
assert self.last_revision() not in pullable_revs
1037
return pullable_revs
1038
except bzrlib.errors.NotAncestor:
1039
if is_ancestor(self.last_revision(), stop_revision, self):
1040
return []
1041
else:
1042
raise e
1043
1044
def basis_tree(self):
1045
"""See Branch.basis_tree."""
1046
return self.repository.revision_tree(self.last_revision())
1047
1048
@deprecated_method(zero_eight)
1049
def working_tree(self):
1050
"""Create a Working tree object for this branch."""
1051
from bzrlib.workingtree import WorkingTree
1052
from bzrlib.transport.local import LocalTransport
1053
if (self.base.find('://') != -1 or
1054
not isinstance(self._transport, LocalTransport)):
1055
raise NoWorkingTree(self.base)
1056
return self.bzrdir.open_workingtree()
1057
1058
@needs_write_lock
1059
def pull(self, source, overwrite=False, stop_revision=None):
1060
"""See Branch.pull."""
1061
source.lock_read()
1062
try:
1063
old_count = len(self.revision_history())
1064
try:
1065
self.update_revisions(source,stop_revision)
1066
except DivergedBranches:
1067
if not overwrite:
1068
raise
1069
if overwrite:
1070
self.set_revision_history(source.revision_history())
1071
new_count = len(self.revision_history())
1072
return new_count - old_count
1073
finally:
1074
source.unlock()
1075
1076
def get_parent(self):
1077
"""See Branch.get_parent."""
1078
import errno
1079
_locs = ['parent', 'pull', 'x-pull']
1080
for l in _locs:
1081
try:
1082
return self.control_files.get_utf8(l).read().strip('\n')
1083
except NoSuchFile:
1084
pass
1085
return None
1086
1087
def get_push_location(self):
1088
"""See Branch.get_push_location."""
1089
config = bzrlib.config.BranchConfig(self)
1090
push_loc = config.get_user_option('push_location')
1091
return push_loc
1092
1093
def set_push_location(self, location):
1094
"""See Branch.set_push_location."""
1095
config = bzrlib.config.LocationConfig(self.base)
1096
config.set_user_option('push_location', location)
1097
1098
@needs_write_lock
1099
def set_parent(self, url):
1100
"""See Branch.set_parent."""
1101
# TODO: Maybe delete old location files?
1102
# URLs should never be unicode, even on the local fs,
1103
# FIXUP this and get_parent in a future branch format bump:
1104
# read and rewrite the file, and have the new format code read
1105
# using .get not .get_utf8. RBC 20060125
1106
self.control_files.put_utf8('parent', url + '\n')
1107
1108
def tree_config(self):
1109
return TreeConfig(self)
1110
1111
1112
class BzrBranch5(BzrBranch):
1113
"""A format 5 branch. This supports new features over plan branches.
1114
1115
It has support for a master_branch which is the data for bound branches.
1116
"""
1117
1118
def __init__(self,
1119
_format,
1120
_control_files,
1121
a_bzrdir,
1122
_repository):
1123
super(BzrBranch5, self).__init__(_format=_format,
1124
_control_files=_control_files,
1125
a_bzrdir=a_bzrdir,
1126
_repository=_repository)
1127
1128
@needs_write_lock
1129
def pull(self, source, overwrite=False, stop_revision=None):
1130
"""Updates branch.pull to be bound branch aware."""
1131
bound_location = self.get_bound_location()
1132
if source.base != bound_location:
1133
# not pulling from master, so we need to update master.
1134
master_branch = self.get_master_branch()
1135
if master_branch:
1136
master_branch.pull(source)
1137
source = master_branch
1138
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1139
1140
def get_bound_location(self):
1141
try:
1142
return self.control_files.get_utf8('bound').read()[:-1]
1143
except errors.NoSuchFile:
1144
return None
1145
1146
@needs_read_lock
1147
def get_master_branch(self):
1148
"""Return the branch we are bound to.
1149
1150
:return: Either a Branch, or None
1151
1152
This could memoise the branch, but if thats done
1153
it must be revalidated on each new lock.
1154
So for now we just dont memoise it.
1155
# RBC 20060304 review this decision.
1156
"""
1157
bound_loc = self.get_bound_location()
1158
if not bound_loc:
1159
return None
1160
try:
1161
return Branch.open(bound_loc)
1162
except (errors.NotBranchError, errors.ConnectionError), e:
1163
raise errors.BoundBranchConnectionFailure(
1164
self, bound_loc, e)
1165
1166
@needs_write_lock
1167
def set_bound_location(self, location):
1168
"""Set the target where this branch is bound to.
1169
1170
:param location: URL to the target branch
1171
"""
1172
if location:
1173
self.control_files.put_utf8('bound', location+'\n')
1174
else:
1175
try:
1176
self.control_files._transport.delete('bound')
1177
except NoSuchFile:
1178
return False
1179
return True
1180
1181
@needs_write_lock
1182
def bind(self, other):
1183
"""Bind the local branch the other branch.
1184
1185
:param other: The branch to bind to
1186
:type other: Branch
1187
"""
1188
# TODO: jam 20051230 Consider checking if the target is bound
1189
# It is debatable whether you should be able to bind to
1190
# a branch which is itself bound.
1191
# Committing is obviously forbidden,
1192
# but binding itself may not be.
1193
# Since we *have* to check at commit time, we don't
1194
# *need* to check here
1195
self.pull(other)
1196
1197
# we are now equal to or a suffix of other.
1198
1199
# Since we have 'pulled' from the remote location,
1200
# now we should try to pull in the opposite direction
1201
# in case the local tree has more revisions than the
1202
# remote one.
1203
# There may be a different check you could do here
1204
# rather than actually trying to install revisions remotely.
1205
# TODO: capture an exception which indicates the remote branch
1206
# is not writeable.
1207
# If it is up-to-date, this probably should not be a failure
1208
1209
# lock other for write so the revision-history syncing cannot race
1210
other.lock_write()
1211
try:
1212
other.pull(self)
1213
# if this does not error, other now has the same last rev we do
1214
# it can only error if the pull from other was concurrent with
1215
# a commit to other from someone else.
1216
1217
# until we ditch revision-history, we need to sync them up:
1218
self.set_revision_history(other.revision_history())
1219
# now other and self are up to date with each other and have the
1220
# same revision-history.
1221
finally:
1222
other.unlock()
1223
1224
self.set_bound_location(other.base)
1225
1226
@needs_write_lock
1227
def unbind(self):
1228
"""If bound, unbind"""
1229
return self.set_bound_location(None)
1230
1231
@needs_write_lock
1232
def update(self):
1233
"""Synchronise this branch with the master branch if any.
1234
1235
:return: None or the last_revision that was pivoted out during the
1236
update.
1237
"""
1238
master = self.get_master_branch()
1239
if master is not None:
1240
old_tip = self.last_revision()
1241
self.pull(master, overwrite=True)
1242
if old_tip in self.repository.get_ancestry(self.last_revision()):
1243
return None
1244
return old_tip
1245
return None
1246
1247
1248
class BranchTestProviderAdapter(object):
1249
"""A tool to generate a suite testing multiple branch formats at once.
1250
1251
This is done by copying the test once for each transport and injecting
1252
the transport_server, transport_readonly_server, and branch_format
1253
classes into each copy. Each copy is also given a new id() to make it
1254
easy to identify.
1255
"""
1256
1257
def __init__(self, transport_server, transport_readonly_server, formats):
1258
self._transport_server = transport_server
1259
self._transport_readonly_server = transport_readonly_server
1260
self._formats = formats
789
1261
1262
def adapt(self, test):
1263
result = TestSuite()
1264
for branch_format, bzrdir_format in self._formats:
1265
new_test = deepcopy(test)
1266
new_test.transport_server = self._transport_server
1267
new_test.transport_readonly_server = self._transport_readonly_server
1268
new_test.bzrdir_format = bzrdir_format
1269
new_test.branch_format = branch_format
1270
def make_new_test_id():
1271
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1272
return lambda: new_id
1273
new_test.id = make_new_test_id()
1274
result.addTest(new_test)
1275
return result
1276
790
1277
791
1278
######################################################################
792
1279
# predicates
793
1280
794
1281
795
def is_control_file(filename):
796
## FIXME: better check
797
filename = os.path.normpath(filename)
798
while filename != '':
799
head, tail = os.path.split(filename)
800
## mutter('check %r for control file' % ((head, tail), ))
801
if tail == bzrlib.BZRDIR:
802
return True
803
if filename == head:
804
break
805
filename = head
806
return False
807
808
809
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
def gen_file_id(name):
818
"""Return new file id.
819
820
This should probably generate proper UUIDs, but for the moment we
821
cope with just randomness because running uuidgen every time is
822
slow."""
823
idx = name.rfind('/')
824
if idx != -1:
825
name = name[idx+1 : ]
826
827
name = name.lstrip('.')
828
829
s = hexlify(rand_bytes(8))
830
return '-'.join((name, compact_date(time.time()), s))
831
832
1282
@deprecated_function(zero_eight)
1283
def ScratchBranch(*args, **kwargs):
1284
"""See bzrlib.bzrdir.ScratchDir."""
1285
d = ScratchDir(*args, **kwargs)
1286
return d.open_branch()
1287
1288
1289
@deprecated_function(zero_eight)
1290
def is_control_file(*args, **kwargs):
1291
"""See bzrlib.workingtree.is_control_file."""
1292
return bzrlib.workingtree.is_control_file(*args, **kwargs)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1