To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1551.13.5
- compare with another revision
- download diff
- download tarball
- view history from revision 1551.13.5
- Committer: Aaron Bentley
- Date: 2007-03-27 13:26:24 UTC
- mto: (1551.19.24 Aaron's mergeable stuff)
- mto: This revision was merged to the branch mainline in revision 2382.
- Revision ID: abentley@panoramicfeedback.com-20070327132624-4v0gvw2iraaov6su
Deprecate Branch.get_root_id
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/benchmarks/tree_creator
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- bzrlib/repofmt
- bzrlib/store
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/intertree_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/per_lock
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/tree_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/version_info_formats
- tools/doc_generate
- tools/win32
- files removed:
- bzrlib/mdiff.py
- notes
- patches
- plugins/changeset
- urlgrabber
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testlog.py => bzrlib/tests/test_log.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevision.py => bzrlib/tests/test_revision.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- tutorial.txt => doc/tutorial.txt
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006, 2007 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
import sys
19
import os
18
from cStringIO import StringIO
19
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
20
25
21
26
import bzrlib
27
from bzrlib import (
28
bzrdir,
29
cache_utf8,
30
config as _mod_config,
31
errors,
32
lockdir,
33
lockable_files,
34
osutils,
35
revision as _mod_revision,
36
transport,
37
tree,
38
ui,
39
urlutils,
40
)
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
44
BasicTags,
45
DisabledTags,
46
)
47
""")
48
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
56
)
57
from bzrlib.symbol_versioning import (deprecated_function,
58
deprecated_method,
59
DEPRECATED_PARAMETER,
60
deprecated_passed,
61
zero_eight, zero_nine, zero_sixteen,
62
)
22
63
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
import bzrlib.errors
28
from bzrlib.textui import show_status
29
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
35
## TODO: Maybe include checks for common corruption of newlines, etc?
36
64
65
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
69
70
71
# TODO: Maybe include checks for common corruption of newlines, etc?
37
72
38
73
# TODO: Some operations like log might retrieve the same revisions
39
74
# repeatedly to calculate deltas. We could perhaps have a weakref
40
# cache in memory to make this faster.
41
42
43
def find_branch(f, **args):
44
if f and (f.startswith('http://') or f.startswith('https://')):
45
import remotebranch
46
return remotebranch.RemoteBranch(f, **args)
47
else:
48
return Branch(f, **args)
49
50
51
def find_cached_branch(f, cache_root, **args):
52
from remotebranch import RemoteBranch
53
br = find_branch(f, **args)
54
def cacheify(br, store_name):
55
from meta_store import CachedStore
56
cache_path = os.path.join(cache_root, store_name)
57
os.mkdir(cache_path)
58
new_store = CachedStore(getattr(br, store_name), cache_path)
59
setattr(br, store_name, new_store)
60
61
if isinstance(br, RemoteBranch):
62
cacheify(br, 'inventory_store')
63
cacheify(br, 'text_store')
64
cacheify(br, 'revision_store')
65
return br
66
67
68
def _relpath(base, path):
69
"""Return path relative to base, or raise exception.
70
71
The path may be either an absolute path or a path relative to the
72
current working directory.
73
74
Lifted out of Branch.relpath for ease of testing.
75
76
os.path.commonprefix (python2.4) has a bad bug that it works just
77
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
78
avoids that problem."""
79
rp = os.path.abspath(path)
80
81
s = []
82
head = rp
83
while len(head) >= len(base):
84
if head == base:
85
break
86
head, tail = os.path.split(head)
87
if tail:
88
s.insert(0, tail)
89
else:
90
from errors import NotBranchError
91
raise NotBranchError("path %r is not within branch %r" % (rp, base))
92
93
return os.sep.join(s)
94
95
96
def find_branch_root(f=None):
97
"""Find the branch root enclosing f, or pwd.
98
99
f may be a filename or a URL.
100
101
It is not necessary that f exists.
102
103
Basically we keep looking up until we find the control directory or
104
run into the root."""
105
if f == None:
106
f = os.getcwd()
107
elif hasattr(os.path, 'realpath'):
108
f = os.path.realpath(f)
109
else:
110
f = os.path.abspath(f)
111
if not os.path.exists(f):
112
raise BzrError('%r does not exist' % f)
113
114
115
orig_f = f
116
117
while True:
118
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
119
return f
120
head, tail = os.path.split(f)
121
if head == f:
122
# reached the root, whatever that may be
123
raise BzrError('%r is not in a branch' % orig_f)
124
f = head
125
126
class DivergedBranches(Exception):
127
def __init__(self, branch1, branch2):
128
self.branch1 = branch1
129
self.branch2 = branch2
130
Exception.__init__(self, "These branches have diverged.")
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
131
78
132
79
133
80
######################################################################
137
84
"""Branch holding a history of revisions.
138
85
139
86
base
140
Base directory of the branch.
141
142
_lock_mode
143
None, or 'r' or 'w'
144
145
_lock_count
146
If _lock_mode is true, a positive count of the number of times the
147
lock has been taken.
148
149
_lock
150
Lock object from bzrlib.lock.
87
Base directory/url of the branch.
88
89
hooks: An instance of BranchHooks.
151
90
"""
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
152
93
base = None
153
_lock_mode = None
154
_lock_count = None
155
_lock = None
156
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
161
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
164
165
base -- Base directory for the branch.
166
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
169
be versioned.
170
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
173
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
176
"""
177
from bzrlib.store import ImmutableStore
178
if init:
179
self.base = os.path.realpath(base)
180
self._make_control()
181
elif find_root:
182
self.base = find_branch_root(base)
183
else:
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
190
self._check_format()
191
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
195
196
197
def __str__(self):
198
return '%s(%r)' % (self.__class__.__name__, self.base)
199
200
201
__repr__ = __str__
202
203
204
def __del__(self):
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
208
self._lock.unlock()
209
210
94
95
# override this to set the strategy for storing tags
96
def _make_tags(self):
97
return DisabledTags(self)
98
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
self._revision_history_cache = None
102
103
def break_lock(self):
104
"""Break a lock if one is present from another instance.
105
106
Uses the ui factory to ask for confirmation if the lock may be from
107
an active process.
108
109
This will probe the repository for its lock as well.
110
"""
111
self.control_files.break_lock()
112
self.repository.break_lock()
113
master = self.get_master_branch()
114
if master is not None:
115
master.break_lock()
116
117
@staticmethod
118
@deprecated_method(zero_eight)
119
def open_downlevel(base):
120
"""Open a branch which may be of an old format."""
121
return Branch.open(base, _unsupported=True)
122
123
@staticmethod
124
def open(base, _unsupported=False):
125
"""Open the branch rooted at base.
126
127
For instance, if the branch is at URL/.bzr/branch,
128
Branch.open(URL) -> a Branch instance.
129
"""
130
control = bzrdir.BzrDir.open(base, _unsupported)
131
return control.open_branch(_unsupported)
132
133
@staticmethod
134
def open_containing(url):
135
"""Open an existing branch which contains url.
136
137
This probes for a branch at url, and searches upwards from there.
138
139
Basically we keep looking up until we find the control directory or
140
run into the root. If there isn't one, raises NotBranchError.
141
If there is one and it is either an unrecognised format or an unsupported
142
format, UnknownFormatError or UnsupportedFormatError are raised.
143
If there is one, it is returned, along with the unused portion of url.
144
"""
145
control, relpath = bzrdir.BzrDir.open_containing(url)
146
return control.open_branch(), relpath
147
148
@staticmethod
149
@deprecated_function(zero_eight)
150
def initialize(base):
151
"""Create a new working tree and branch, rooted at 'base' (url)
152
153
NOTE: This will soon be deprecated in favour of creation
154
through a BzrDir.
155
"""
156
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
157
158
@deprecated_function(zero_eight)
159
def setup_caching(self, cache_root):
160
"""Subclasses that care about caching should override this, and set
161
up cached stores located under cache_root.
162
163
NOTE: This is unused.
164
"""
165
pass
166
167
def get_config(self):
168
return BranchConfig(self)
169
170
def _get_nick(self):
171
return self.get_config().get_nickname()
172
173
def _set_nick(self, nick):
174
self.get_config().set_user_option('nickname', nick)
175
176
nick = property(_get_nick, _set_nick)
177
178
def is_locked(self):
179
raise NotImplementedError(self.is_locked)
211
180
212
181
def lock_write(self):
213
if self._lock_mode:
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
217
self._lock_mode)
218
self._lock_count += 1
219
else:
220
from bzrlib.lock import WriteLock
221
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
224
self._lock_count = 1
225
226
182
raise NotImplementedError(self.lock_write)
227
183
228
184
def lock_read(self):
229
if self._lock_mode:
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
233
else:
234
from bzrlib.lock import ReadLock
235
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
238
self._lock_count = 1
239
240
241
185
raise NotImplementedError(self.lock_read)
186
242
187
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
246
247
if self._lock_count > 1:
248
self._lock_count -= 1
249
else:
250
self._lock.unlock()
251
self._lock = None
252
self._lock_mode = self._lock_count = None
253
188
raise NotImplementedError(self.unlock)
189
190
def peek_lock_mode(self):
191
"""Return lock mode for the Branch: 'r', 'w' or None"""
192
raise NotImplementedError(self.peek_lock_mode)
193
194
def get_physical_lock_status(self):
195
raise NotImplementedError(self.get_physical_lock_status)
254
196
255
197
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
258
259
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
262
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
265
266
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
272
273
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
276
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
281
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
284
"""
285
286
fn = self.controlfilename(file_or_path)
287
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
293
import codecs
294
return codecs.open(fn, mode + 'b', 'utf-8',
295
buffering=60000)
296
else:
297
raise BzrError("invalid controlfile mode %r" % mode)
298
299
300
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
304
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
314
'branch-lock',
315
'pending-merges'):
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
318
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
320
321
322
def _check_format(self):
323
"""Check this branch format is supported.
324
325
The current tool only supports the current unstable format.
326
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
329
"""
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
339
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
344
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
351
for fid in inv:
352
entry = inv[fid]
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
356
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
362
before = time()
363
self.lock_read()
364
try:
365
# ElementTree does its own conversion from UTF-8, so open in
366
# binary.
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
371
return inv
372
finally:
373
self.unlock()
374
375
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
378
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
381
"""
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
384
385
self.lock_write()
386
try:
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
try:
389
pack_xml(inv, f)
390
f.commit()
391
finally:
392
f.close()
393
finally:
394
self.unlock()
395
396
mutter('wrote working inventory')
397
398
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
401
402
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
405
406
Note that the command line normally calls smart_add instead.
407
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
410
411
files
412
List of paths to add, relative to the base of the tree.
413
414
ids
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
418
419
TODO: Perhaps have an option to add the ids even if the files do
420
not (yet) exist.
421
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
424
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
427
higher-level method.
428
"""
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
433
files = [files]
434
if ids is not None:
435
ids = [ids]
436
437
if ids is None:
438
ids = [None] * len(files)
439
else:
440
assert(len(ids) == len(files))
441
442
self.lock_write()
443
try:
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
448
449
fp = splitpath(f)
450
451
if len(fp) == 0:
452
raise BzrError("cannot add top-level %r" % f)
453
454
fullpath = os.path.normpath(self.abspath(f))
455
456
try:
457
kind = file_kind(fullpath)
458
except OSError:
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
465
if file_id is None:
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
468
469
if verbose:
470
print 'added', quotefn(f)
471
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
474
self._write_inventory(inv)
475
finally:
476
self.unlock()
477
478
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
481
self.lock_read()
482
try:
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
486
if not file_id:
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
489
finally:
490
self.unlock()
491
492
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
495
496
This does not remove their text. This does not run on
497
498
TODO: Refuse to remove modified files unless --force is given?
499
500
TODO: Do something useful with directories.
501
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
506
"""
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
510
files = [files]
511
512
self.lock_write()
513
514
try:
515
tree = self.working_tree()
516
inv = tree.inventory
517
518
# do this before any modifications
519
for f in files:
520
fid = inv.path2id(f)
521
if not fid:
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
524
if verbose:
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
527
new_status = 'I'
528
else:
529
new_status = '?'
530
show_status(new_status, inv[fid].kind, quotefn(f))
531
del inv[fid]
532
533
self._write_inventory(inv)
534
finally:
535
self.unlock()
536
537
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
544
if name == "":
545
continue
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
548
549
550
def unknowns(self):
551
"""Return all unknown files.
552
553
These are files in the working directory that are not versioned or
554
control files or ignored.
555
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
558
['foo']
559
>>> b.add('foo')
560
>>> list(b.unknowns())
561
[]
562
>>> b.remove('foo')
563
>>> list(b.unknowns())
564
['foo']
565
"""
566
return self.working_tree().unknowns()
567
568
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
571
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
574
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
577
578
f = AtomicFile(self.controlfilename('revision-history'))
579
try:
580
for rev_id in rev_history:
581
print >>f, rev_id
582
f.commit()
583
finally:
584
f.close()
585
586
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
591
592
self.lock_read()
593
try:
594
try:
595
return self.revision_store[revision_id]
596
except IndexError:
597
raise bzrlib.errors.NoSuchRevision(revision_id)
598
finally:
599
self.unlock()
600
601
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
605
606
try:
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
[revision_id,
611
str(e)])
612
613
assert r.revision_id == revision_id
614
return r
615
198
"""Return absolute filename for something in the branch
199
200
XXX: Robert Collins 20051017 what is this used for? why is it a branch
201
method and not a tree method.
202
"""
203
raise NotImplementedError(self.abspath)
204
205
def bind(self, other):
206
"""Bind the local branch the other branch.
207
208
:param other: The branch to bind to
209
:type other: Branch
210
"""
211
raise errors.UpgradeRequired(self.base)
212
213
@needs_write_lock
214
def fetch(self, from_branch, last_revision=None, pb=None):
215
"""Copy revisions from from_branch into this branch.
216
217
:param from_branch: Where to copy from.
218
:param last_revision: What revision to stop at (None for at the end
219
of the branch.
220
:param pb: An optional progress bar to use.
221
222
Returns the copied revision count and the failed revisions in a tuple:
223
(copied, failures).
224
"""
225
if self.base == from_branch.base:
226
return (0, [])
227
if pb is None:
228
nested_pb = ui.ui_factory.nested_progress_bar()
229
pb = nested_pb
230
else:
231
nested_pb = None
232
233
from_branch.lock_read()
234
try:
235
if last_revision is None:
236
pb.update('get source history')
237
last_revision = from_branch.last_revision()
238
if last_revision is None:
239
last_revision = _mod_revision.NULL_REVISION
240
return self.repository.fetch(from_branch.repository,
241
revision_id=last_revision,
242
pb=nested_pb)
243
finally:
244
if nested_pb is not None:
245
nested_pb.finished()
246
from_branch.unlock()
247
248
def get_bound_location(self):
249
"""Return the URL of the branch we are bound to.
250
251
Older format branches cannot bind, please be sure to use a metadir
252
branch.
253
"""
254
return None
255
256
def get_old_bound_location(self):
257
"""Return the URL of the branch we used to be bound to
258
"""
259
raise errors.UpgradeRequired(self.base)
260
261
def get_commit_builder(self, parents, config=None, timestamp=None,
262
timezone=None, committer=None, revprops=None,
263
revision_id=None):
264
"""Obtain a CommitBuilder for this branch.
265
266
:param parents: Revision ids of the parents of the new revision.
267
:param config: Optional configuration to use.
268
:param timestamp: Optional timestamp recorded for commit.
269
:param timezone: Optional timezone for timestamp.
270
:param committer: Optional committer to set for commit.
271
:param revprops: Optional dictionary of revision properties.
272
:param revision_id: Optional revision id.
273
"""
274
275
if config is None:
276
config = self.get_config()
277
278
return self.repository.get_commit_builder(self, parents, config,
279
timestamp, timezone, committer, revprops, revision_id)
280
281
def get_master_branch(self):
282
"""Return the branch we are bound to.
283
284
:return: Either a Branch, or None
285
"""
286
return None
616
287
617
288
def get_revision_delta(self, revno):
618
289
"""Return the delta for one revision.
624
295
rh = self.revision_history()
625
296
if not (1 <= revno <= len(rh)):
626
297
raise InvalidRevisionNumber(revno)
627
628
# revno is 1-based; list is 0-based
629
630
new_tree = self.revision_tree(rh[revno-1])
631
if revno == 1:
632
old_tree = EmptyTree()
633
else:
634
old_tree = self.revision_tree(rh[revno-2])
635
636
return compare_trees(old_tree, new_tree)
637
638
639
640
def get_revision_sha1(self, revision_id):
641
"""Hash the stored value of a revision, and return it."""
642
# In the future, revision entries will be signed. At that
643
# point, it is probably best *not* to include the signature
644
# in the revision hash. Because that lets you re-sign
645
# the revision, (add signatures/remove signatures) and still
646
# have all hash pointers stay consistent.
647
# But for now, just hash the contents.
648
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
649
650
651
def get_inventory(self, inventory_id):
652
"""Get Inventory object by hash.
653
654
TODO: Perhaps for this and similar methods, take a revision
655
parameter which can be either an integer revno or a
656
string hash."""
657
from bzrlib.inventory import Inventory
658
from bzrlib.xml import unpack_xml
659
660
return unpack_xml(Inventory, self.inventory_store[inventory_id])
661
662
663
def get_inventory_sha1(self, inventory_id):
664
"""Return the sha1 hash of the inventory entry
665
"""
666
return sha_file(self.inventory_store[inventory_id])
667
668
669
def get_revision_inventory(self, revision_id):
670
"""Return inventory of a past revision."""
671
# bzr 0.0.6 imposes the constraint that the inventory_id
672
# must be the same as its revision, so this is trivial.
673
if revision_id == None:
674
from bzrlib.inventory import Inventory
675
return Inventory(self.get_root_id())
676
else:
677
return self.get_inventory(revision_id)
678
679
298
return self.repository.get_revision_delta(rh[revno-1])
299
300
@deprecated_method(zero_sixteen)
301
def get_root_id(self):
302
"""Return the id of this branches root
303
304
Deprecated: branches don't have root ids-- trees do.
305
Use basis_tree().get_root_id() instead.
306
"""
307
raise NotImplementedError(self.get_root_id)
308
309
def print_file(self, file, revision_id):
310
"""Print `file` to stdout."""
311
raise NotImplementedError(self.print_file)
312
313
def append_revision(self, *revision_ids):
314
raise NotImplementedError(self.append_revision)
315
316
def set_revision_history(self, rev_history):
317
raise NotImplementedError(self.set_revision_history)
318
319
def _cache_revision_history(self, rev_history):
320
"""Set the cached revision history to rev_history.
321
322
The revision_history method will use this cache to avoid regenerating
323
the revision history.
324
325
This API is semi-public; it only for use by subclasses, all other code
326
should consider it to be private.
327
"""
328
self._revision_history_cache = rev_history
329
330
def _clear_cached_state(self):
331
"""Clear any cached data on this branch, e.g. cached revision history.
332
333
This means the next call to revision_history will need to call
334
_gen_revision_history.
335
336
This API is semi-public; it only for use by subclasses, all other code
337
should consider it to be private.
338
"""
339
self._revision_history_cache = None
340
341
def _gen_revision_history(self):
342
"""Return sequence of revision hashes on to this branch.
343
344
Unlike revision_history, this method always regenerates or rereads the
345
revision history, i.e. it does not cache the result, so repeated calls
346
may be expensive.
347
348
Concrete subclasses should override this instead of revision_history so
349
that subclasses do not need to deal with caching logic.
350
351
This API is semi-public; it only for use by subclasses, all other code
352
should consider it to be private.
353
"""
354
raise NotImplementedError(self._gen_revision_history)
355
356
@needs_read_lock
680
357
def revision_history(self):
681
358
"""Return sequence of revision hashes on to this branch.
682
683
>>> ScratchBranch().revision_history()
684
[]
685
"""
686
self.lock_read()
687
try:
688
return [l.rstrip('\r\n') for l in
689
self.controlfile('revision-history', 'r').readlines()]
690
finally:
691
self.unlock()
692
693
694
def common_ancestor(self, other, self_revno=None, other_revno=None):
695
"""
696
>>> import commit
697
>>> sb = ScratchBranch(files=['foo', 'foo~'])
698
>>> sb.common_ancestor(sb) == (None, None)
699
True
700
>>> commit.commit(sb, "Committing first revision", verbose=False)
701
>>> sb.common_ancestor(sb)[0]
702
1
703
>>> clone = sb.clone()
704
>>> commit.commit(sb, "Committing second revision", verbose=False)
705
>>> sb.common_ancestor(sb)[0]
706
2
707
>>> sb.common_ancestor(clone)[0]
708
1
709
>>> commit.commit(clone, "Committing divergent second revision",
710
... verbose=False)
711
>>> sb.common_ancestor(clone)[0]
712
1
713
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
714
True
715
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
716
True
717
>>> clone2 = sb.clone()
718
>>> sb.common_ancestor(clone2)[0]
719
2
720
>>> sb.common_ancestor(clone2, self_revno=1)[0]
721
1
722
>>> sb.common_ancestor(clone2, other_revno=1)[0]
723
1
724
"""
725
my_history = self.revision_history()
726
other_history = other.revision_history()
727
if self_revno is None:
728
self_revno = len(my_history)
729
if other_revno is None:
730
other_revno = len(other_history)
731
indices = range(min((self_revno, other_revno)))
732
indices.reverse()
733
for r in indices:
734
if my_history[r] == other_history[r]:
735
return r+1, my_history[r]
736
return None, None
737
359
360
This method will cache the revision history for as long as it is safe to
361
do so.
362
"""
363
if self._revision_history_cache is not None:
364
history = self._revision_history_cache
365
else:
366
history = self._gen_revision_history()
367
self._cache_revision_history(history)
368
return list(history)
738
369
739
370
def revno(self):
740
371
"""Return current revision number for this branch.
744
375
"""
745
376
return len(self.revision_history())
746
377
747
748
def last_patch(self):
749
"""Return last patch hash, or None if no history.
750
"""
378
def unbind(self):
379
"""Older format branches cannot bind or unbind."""
380
raise errors.UpgradeRequired(self.base)
381
382
def set_append_revisions_only(self, enabled):
383
"""Older format branches are never restricted to append-only"""
384
raise errors.UpgradeRequired(self.base)
385
386
def last_revision(self):
387
"""Return last revision id, or None"""
751
388
ph = self.revision_history()
752
389
if ph:
753
390
return ph[-1]
754
391
else:
755
392
return None
756
393
394
def last_revision_info(self):
395
"""Return information about the last revision.
396
397
:return: A tuple (revno, last_revision_id).
398
"""
399
rh = self.revision_history()
400
revno = len(rh)
401
if revno:
402
return (revno, rh[-1])
403
else:
404
return (0, _mod_revision.NULL_REVISION)
757
405
758
406
def missing_revisions(self, other, stop_revision=None):
759
"""
407
"""Return a list of new revisions that would perfectly fit.
408
760
409
If self and other have not diverged, return a list of the revisions
761
410
present in other, but missing from self.
762
763
>>> from bzrlib.commit import commit
764
>>> bzrlib.trace.silent = True
765
>>> br1 = ScratchBranch()
766
>>> br2 = ScratchBranch()
767
>>> br1.missing_revisions(br2)
768
[]
769
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
770
>>> br1.missing_revisions(br2)
771
[u'REVISION-ID-1']
772
>>> br2.missing_revisions(br1)
773
[]
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
775
>>> br1.missing_revisions(br2)
776
[]
777
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
778
>>> br1.missing_revisions(br2)
779
[u'REVISION-ID-2A']
780
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
781
>>> br1.missing_revisions(br2)
782
Traceback (most recent call last):
783
DivergedBranches: These branches have diverged.
784
411
"""
785
412
self_history = self.revision_history()
786
413
self_len = len(self_history)
793
420
794
421
if stop_revision is None:
795
422
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
798
423
else:
424
assert isinstance(stop_revision, int)
425
if stop_revision > other_len:
426
raise errors.NoSuchRevision(self, stop_revision)
799
427
return other_history[self_len:stop_revision]
800
428
801
802
429
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
804
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
808
>>> br1.add('foo')
809
>>> br1.add('bar')
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
813
Added 2 texts.
814
Added 1 inventories.
815
Added 1 revisions.
816
>>> br2.revision_history()
817
[u'REVISION-ID-1']
818
>>> br2.update_revisions(br1)
819
Added 0 texts.
820
Added 0 inventories.
821
Added 0 revisions.
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
823
True
824
"""
825
from bzrlib.progress import ProgressBar
826
827
pb = ProgressBar()
828
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
831
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
838
839
revisions = []
840
needed_texts = set()
841
i = 0
842
for rev_id in revision_ids:
843
i += 1
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
850
continue
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
853
854
pb.clear()
855
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
860
inventory_ids)
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
864
revision_ids)
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
868
869
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
873
874
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
878
return info
879
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
882
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
887
"""
888
if revision is None:
889
return 0, None
890
revno = None
891
try:# Convert to int if possible
892
revision = int(revision)
893
except ValueError:
894
pass
895
revs = self.revision_history()
896
if isinstance(revision, int):
897
if revision == 0:
898
return 0, None
899
# Mabye we should do this first, but we don't need it if revision == 0
900
if revision < 0:
901
revno = len(revs) + revision + 1
902
else:
903
revno = revision
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
908
break
909
else:
910
raise BzrError('No namespace registered for string: %r' % revision)
911
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
915
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
919
try:
920
return int(revision[6:])
921
except ValueError:
922
return None
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
924
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
927
try:
928
return revs.index(revision[6:]) + 1
929
except ValueError:
930
return None
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
932
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
935
try:
936
offset = int(revision[5:])
937
except ValueError:
938
return None
939
else:
940
if offset <= 0:
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
944
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
949
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
952
import datetime
953
# Spec for date revisions:
954
# date:value
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
959
#
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
964
#
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
968
val = revision[5:]
969
match_style = '='
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
972
val = val[1:]
973
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
978
dt = today
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
981
else:
982
import re
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
986
r'(,|T)?\s*'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
988
)
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
992
993
if m.group('date'):
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
995
else:
996
year, month, day = today.year, today.month, today.day
997
if m.group('time'):
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1002
else:
1003
second = 0
1004
else:
1005
hour, minute, second = 0,0,0
1006
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1009
first = dt
1010
last = None
1011
reversed = False
1012
if match_style == '-':
1013
reversed = True
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1016
1017
if reversed:
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1023
return i+1
1024
else:
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1030
return i+1
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1032
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1035
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1041
return EmptyTree()
1042
else:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1045
1046
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
1051
430
"""Pull in new perfect-fit revisions.
431
432
:param other: Another Branch to pull from
433
:param stop_revision: Updated until the given revision
434
:return: None
435
"""
436
raise NotImplementedError(self.update_revisions)
437
438
def revision_id_to_revno(self, revision_id):
439
"""Given a revision id, return its revno"""
440
if revision_id is None:
441
return 0
442
revision_id = osutils.safe_revision_id(revision_id)
443
history = self.revision_history()
444
try:
445
return history.index(revision_id) + 1
446
except ValueError:
447
raise bzrlib.errors.NoSuchRevision(self, revision_id)
448
449
def get_rev_id(self, revno, history=None):
450
"""Find the revision id of the specified revno."""
451
if revno == 0:
452
return None
453
if history is None:
454
history = self.revision_history()
455
if revno <= 0 or revno > len(history):
456
raise bzrlib.errors.NoSuchRevision(self, revno)
457
return history[revno - 1]
458
459
def pull(self, source, overwrite=False, stop_revision=None):
460
"""Mirror source into this branch.
461
462
This branch is considered to be 'local', having low latency.
463
464
:returns: PullResult instance
465
"""
466
raise NotImplementedError(self.pull)
467
468
def push(self, target, overwrite=False, stop_revision=None):
469
"""Mirror this branch into target.
470
471
This branch is considered to be 'local', having low latency.
472
"""
473
raise NotImplementedError(self.push)
1052
474
1053
475
def basis_tree(self):
1054
"""Return `Tree` object for last revision.
1055
1056
If there are no revisions yet, return an `EmptyTree`.
1057
"""
1058
r = self.last_patch()
1059
if r == None:
1060
return EmptyTree()
1061
else:
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1063
1064
476
"""Return `Tree` object for last revision."""
477
return self.repository.revision_tree(self.last_revision())
1065
478
1066
479
def rename_one(self, from_rel, to_rel):
1067
480
"""Rename one file.
1068
481
1069
482
This can change the directory or the filename or both.
1070
483
"""
1071
self.lock_write()
1072
try:
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1079
1080
file_id = inv.path2id(from_rel)
1081
if file_id == None:
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1083
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1086
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1091
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1098
1099
inv.rename(file_id, to_dir_id, to_tail)
1100
1101
print "%s => %s" % (from_rel, to_rel)
1102
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1105
try:
1106
os.rename(from_abs, to_abs)
1107
except OSError, e:
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1111
1112
self._write_inventory(inv)
1113
finally:
1114
self.unlock()
1115
484
raise NotImplementedError(self.rename_one)
1116
485
1117
486
def move(self, from_paths, to_name):
1118
487
"""Rename files.
1124
493
1125
494
Note that to_name is only the last component of the new name;
1126
495
this doesn't change the directory.
1127
"""
1128
self.lock_write()
1129
try:
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1145
1146
to_idpath = inv.get_idpath(to_dir_id)
1147
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1152
if f_id == None:
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1160
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1164
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1170
try:
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1172
except OSError, e:
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1175
1176
self._write_inventory(inv)
1177
finally:
1178
self.unlock()
1179
1180
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1183
1184
backups
1185
If true (default) backups are made of files before
1186
they're renamed.
1187
"""
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1191
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1196
1197
nids = []
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1200
if not file_id:
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1205
1206
# TODO: Rename back if it was previously at a different location
1207
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1210
1211
# TODO: Make a backup to a temporary file.
1212
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1215
backup_file(fn)
1216
1217
f = AtomicFile(fn, 'wb')
1218
try:
1219
f.write(old_tree.get_file(file_id).read())
1220
f.commit()
1221
finally:
1222
f.close()
1223
1224
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1227
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1230
"""
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1233
return []
1234
p = []
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1237
return p
1238
1239
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1242
1243
validate_revision_id(revision_id)
1244
1245
p = self.pending_merges()
1246
if revision_id in p:
1247
return
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1250
1251
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1254
self.lock_write()
1255
try:
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1257
try:
1258
for l in rev_list:
1259
print >>f, l
1260
f.commit()
1261
finally:
1262
f.close()
1263
finally:
1264
self.unlock()
1265
1266
1267
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1270
1271
>>> b = ScratchBranch()
1272
>>> isdir(b.base)
1273
True
1274
>>> bd = b.base
1275
>>> b.destroy()
1276
>>> isdir(bd)
1277
False
1278
"""
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1281
1282
This creates a temporary directory and runs init-tree in it.
1283
1284
If any files are listed, they are created in the working copy.
1285
"""
1286
from tempfile import mkdtemp
1287
init = False
1288
if base is None:
1289
base = mkdtemp()
1290
init = True
1291
Branch.__init__(self, base, init=init)
1292
for d in dirs:
1293
os.mkdir(self.abspath(d))
1294
1295
for f in files:
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1297
1298
1299
def clone(self):
1300
"""
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1304
False
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
True
1307
"""
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1310
base = mkdtemp()
1311
os.rmdir(base)
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1314
1315
def __del__(self):
1316
self.destroy()
1317
1318
def destroy(self):
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1321
try:
1322
if self.base:
1323
mutter("delete ScratchBranch %s" % self.base)
1324
rmtree(self.base)
1325
except OSError, e:
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1330
for name in files:
1331
os.chmod(os.path.join(root, name), 0700)
1332
rmtree(self.base)
1333
self.base = None
1334
1335
1336
1337
######################################################################
1338
# predicates
1339
1340
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
496
497
This returns a list of (from_path, to_path) pairs for each
498
entry that is moved.
499
"""
500
raise NotImplementedError(self.move)
501
502
def get_parent(self):
503
"""Return the parent location of the branch.
504
505
This is the default location for push/pull/missing. The usual
506
pattern is that the user can override it by specifying a
507
location.
508
"""
509
raise NotImplementedError(self.get_parent)
510
511
def _set_config_location(self, name, url, config=None,
512
make_relative=False):
513
if config is None:
514
config = self.get_config()
515
if url is None:
516
url = ''
517
elif make_relative:
518
url = urlutils.relative_url(self.base, url)
519
config.set_user_option(name, url)
520
521
def _get_config_location(self, name, config=None):
522
if config is None:
523
config = self.get_config()
524
location = config.get_user_option(name)
525
if location == '':
526
location = None
527
return location
528
529
def get_submit_branch(self):
530
"""Return the submit location of the branch.
531
532
This is the default location for bundle. The usual
533
pattern is that the user can override it by specifying a
534
location.
535
"""
536
return self.get_config().get_user_option('submit_branch')
537
538
def set_submit_branch(self, location):
539
"""Return the submit location of the branch.
540
541
This is the default location for bundle. The usual
542
pattern is that the user can override it by specifying a
543
location.
544
"""
545
self.get_config().set_user_option('submit_branch', location)
546
547
def get_public_branch(self):
548
"""Return the public location of the branch.
549
550
This is is used by merge directives.
551
"""
552
return self._get_config_location('public_branch')
553
554
def set_public_branch(self, location):
555
"""Return the submit location of the branch.
556
557
This is the default location for bundle. The usual
558
pattern is that the user can override it by specifying a
559
location.
560
"""
561
self._set_config_location('public_branch', location)
562
563
def get_push_location(self):
564
"""Return the None or the location to push this branch to."""
565
raise NotImplementedError(self.get_push_location)
566
567
def set_push_location(self, location):
568
"""Set a new push location for this branch."""
569
raise NotImplementedError(self.set_push_location)
570
571
def set_parent(self, url):
572
raise NotImplementedError(self.set_parent)
573
574
@needs_write_lock
575
def update(self):
576
"""Synchronise this branch with the master branch if any.
577
578
:return: None or the last_revision pivoted out during the update.
579
"""
580
return None
581
582
def check_revno(self, revno):
583
"""\
584
Check whether a revno corresponds to any revision.
585
Zero (the NULL revision) is considered valid.
586
"""
587
if revno != 0:
588
self.check_real_revno(revno)
589
590
def check_real_revno(self, revno):
591
"""\
592
Check whether a revno corresponds to a real revision.
593
Zero (the NULL revision) is considered invalid
594
"""
595
if revno < 1 or revno > self.revno():
596
raise InvalidRevisionNumber(revno)
597
598
@needs_read_lock
599
def clone(self, *args, **kwargs):
600
"""Clone this branch into to_bzrdir preserving all semantic values.
601
602
revision_id: if not None, the revision history in the new branch will
603
be truncated to end with revision_id.
604
"""
605
# for API compatibility, until 0.8 releases we provide the old api:
606
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
607
# after 0.8 releases, the *args and **kwargs should be changed:
608
# def clone(self, to_bzrdir, revision_id=None):
609
if (kwargs.get('to_location', None) or
610
kwargs.get('revision', None) or
611
kwargs.get('basis_branch', None) or
612
(len(args) and isinstance(args[0], basestring))):
613
# backwards compatibility api:
614
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
615
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
616
# get basis_branch
617
if len(args) > 2:
618
basis_branch = args[2]
619
else:
620
basis_branch = kwargs.get('basis_branch', None)
621
if basis_branch:
622
basis = basis_branch.bzrdir
623
else:
624
basis = None
625
# get revision
626
if len(args) > 1:
627
revision_id = args[1]
628
else:
629
revision_id = kwargs.get('revision', None)
630
# get location
631
if len(args):
632
url = args[0]
633
else:
634
# no default to raise if not provided.
635
url = kwargs.get('to_location')
636
return self.bzrdir.clone(url,
637
revision_id=revision_id,
638
basis=basis).open_branch()
639
# new cleaner api.
640
# generate args by hand
641
if len(args) > 1:
642
revision_id = args[1]
643
else:
644
revision_id = kwargs.get('revision_id', None)
645
if len(args):
646
to_bzrdir = args[0]
647
else:
648
# no default to raise if not provided.
649
to_bzrdir = kwargs.get('to_bzrdir')
650
result = self._format.initialize(to_bzrdir)
651
self.copy_content_into(result, revision_id=revision_id)
652
return result
653
654
@needs_read_lock
655
def sprout(self, to_bzrdir, revision_id=None):
656
"""Create a new line of development from the branch, into to_bzrdir.
657
658
revision_id: if not None, the revision history in the new branch will
659
be truncated to end with revision_id.
660
"""
661
result = self._format.initialize(to_bzrdir)
662
self.copy_content_into(result, revision_id=revision_id)
663
result.set_parent(self.bzrdir.root_transport.base)
664
return result
665
666
def _synchronize_history(self, destination, revision_id):
667
"""Synchronize last revision and revision history between branches.
668
669
This version is most efficient when the destination is also a
670
BzrBranch5, but works for BzrBranch6 as long as the revision
671
history is the true lefthand parent history, and all of the revisions
672
are in the destination's repository. If not, set_revision_history
673
will fail.
674
675
:param destination: The branch to copy the history into
676
:param revision_id: The revision-id to truncate history at. May
677
be None to copy complete history.
678
"""
679
new_history = self.revision_history()
680
if revision_id is not None:
681
revision_id = osutils.safe_revision_id(revision_id)
682
try:
683
new_history = new_history[:new_history.index(revision_id) + 1]
684
except ValueError:
685
rev = self.repository.get_revision(revision_id)
686
new_history = rev.get_history(self.repository)[1:]
687
destination.set_revision_history(new_history)
688
689
@needs_read_lock
690
def copy_content_into(self, destination, revision_id=None):
691
"""Copy the content of self into destination.
692
693
revision_id: if not None, the revision history in the new branch will
694
be truncated to end with revision_id.
695
"""
696
self._synchronize_history(destination, revision_id)
697
try:
698
parent = self.get_parent()
699
except errors.InaccessibleParent, e:
700
mutter('parent was not accessible to copy: %s', e)
701
else:
702
if parent:
703
destination.set_parent(parent)
704
self.tags.merge_to(destination.tags)
705
706
@needs_read_lock
707
def check(self):
708
"""Check consistency of the branch.
709
710
In particular this checks that revisions given in the revision-history
711
do actually match up in the revision graph, and that they're all
712
present in the repository.
713
714
Callers will typically also want to check the repository.
715
716
:return: A BranchCheckResult.
717
"""
718
mainline_parent_id = None
719
for revision_id in self.revision_history():
720
try:
721
revision = self.repository.get_revision(revision_id)
722
except errors.NoSuchRevision, e:
723
raise errors.BzrCheckError("mainline revision {%s} not in repository"
724
% revision_id)
725
# In general the first entry on the revision history has no parents.
726
# But it's not illegal for it to have parents listed; this can happen
727
# in imports from Arch when the parents weren't reachable.
728
if mainline_parent_id is not None:
729
if mainline_parent_id not in revision.parent_ids:
730
raise errors.BzrCheckError("previous revision {%s} not listed among "
731
"parents of {%s}"
732
% (mainline_parent_id, revision_id))
733
mainline_parent_id = revision_id
734
return BranchCheckResult(self)
735
736
def _get_checkout_format(self):
737
"""Return the most suitable metadir for a checkout of this branch.
738
Weaves are used if this branch's repostory uses weaves.
739
"""
740
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
741
from bzrlib.repofmt import weaverepo
742
format = bzrdir.BzrDirMetaFormat1()
743
format.repository_format = weaverepo.RepositoryFormat7()
744
else:
745
format = self.repository.bzrdir.checkout_metadir()
746
format.set_branch_format(self._format)
747
return format
748
749
def create_checkout(self, to_location, revision_id=None,
750
lightweight=False):
751
"""Create a checkout of a branch.
752
753
:param to_location: The url to produce the checkout at
754
:param revision_id: The revision to check out
755
:param lightweight: If True, produce a lightweight checkout, otherwise,
756
produce a bound branch (heavyweight checkout)
757
:return: The tree of the created checkout
758
"""
759
t = transport.get_transport(to_location)
760
try:
761
t.mkdir('.')
762
except errors.FileExists:
763
pass
764
if lightweight:
765
format = self._get_checkout_format()
766
checkout = format.initialize_on_transport(t)
767
BranchReferenceFormat().initialize(checkout, self)
768
else:
769
format = self._get_checkout_format()
770
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
771
to_location, force_new_tree=False, format=format)
772
checkout = checkout_branch.bzrdir
773
checkout_branch.bind(self)
774
# pull up to the specified revision_id to set the initial
775
# branch tip correctly, and seed it with history.
776
checkout_branch.pull(self, stop_revision=revision_id)
777
tree = checkout.create_workingtree(revision_id)
778
basis_tree = tree.basis_tree()
779
basis_tree.lock_read()
780
try:
781
for path, file_id in basis_tree.iter_references():
782
reference_parent = self.reference_parent(file_id, path)
783
reference_parent.create_checkout(tree.abspath(path),
784
basis_tree.get_reference_revision(file_id, path),
785
lightweight)
786
finally:
787
basis_tree.unlock()
788
return tree
789
790
def reference_parent(self, file_id, path):
791
"""Return the parent branch for a tree-reference file_id
792
:param file_id: The file_id of the tree reference
793
:param path: The path of the file_id in the tree
794
:return: A branch associated with the file_id
795
"""
796
# FIXME should provide multiple branches, based on config
797
return Branch.open(self.bzrdir.root_transport.clone(path).base)
798
799
def supports_tags(self):
800
return self._format.supports_tags()
801
802
803
class BranchFormat(object):
804
"""An encapsulation of the initialization and open routines for a format.
805
806
Formats provide three things:
807
* An initialization routine,
808
* a format string,
809
* an open routine.
810
811
Formats are placed in an dict by their format string for reference
812
during branch opening. Its not required that these be instances, they
813
can be classes themselves with class methods - it simply depends on
814
whether state is needed for a given format or not.
815
816
Once a format is deprecated, just deprecate the initialize and open
817
methods on the format class. Do not deprecate the object, as the
818
object will be created every time regardless.
819
"""
820
821
_default_format = None
822
"""The default format used for new branches."""
823
824
_formats = {}
825
"""The known formats."""
826
827
@classmethod
828
def find_format(klass, a_bzrdir):
829
"""Return the format for the branch object in a_bzrdir."""
830
try:
831
transport = a_bzrdir.get_branch_transport(None)
832
format_string = transport.get("format").read()
833
return klass._formats[format_string]
834
except NoSuchFile:
835
raise NotBranchError(path=transport.base)
836
except KeyError:
837
raise errors.UnknownFormatError(format=format_string)
838
839
@classmethod
840
def get_default_format(klass):
841
"""Return the current default format."""
842
return klass._default_format
843
844
def get_format_string(self):
845
"""Return the ASCII format string that identifies this format."""
846
raise NotImplementedError(self.get_format_string)
847
848
def get_format_description(self):
849
"""Return the short format description for this format."""
850
raise NotImplementedError(self.get_format_description)
851
852
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
853
set_format=True):
854
"""Initialize a branch in a bzrdir, with specified files
855
856
:param a_bzrdir: The bzrdir to initialize the branch in
857
:param utf8_files: The files to create as a list of
858
(filename, content) tuples
859
:param set_format: If True, set the format with
860
self.get_format_string. (BzrBranch4 has its format set
861
elsewhere)
862
:return: a branch in this format
863
"""
864
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
865
branch_transport = a_bzrdir.get_branch_transport(self)
866
lock_map = {
867
'metadir': ('lock', lockdir.LockDir),
868
'branch4': ('branch-lock', lockable_files.TransportLock),
869
}
870
lock_name, lock_class = lock_map[lock_type]
871
control_files = lockable_files.LockableFiles(branch_transport,
872
lock_name, lock_class)
873
control_files.create_lock()
874
control_files.lock_write()
875
if set_format:
876
control_files.put_utf8('format', self.get_format_string())
877
try:
878
for file, content in utf8_files:
879
control_files.put_utf8(file, content)
880
finally:
881
control_files.unlock()
882
return self.open(a_bzrdir, _found=True)
883
884
def initialize(self, a_bzrdir):
885
"""Create a branch of this format in a_bzrdir."""
886
raise NotImplementedError(self.initialize)
887
888
def is_supported(self):
889
"""Is this format supported?
890
891
Supported formats can be initialized and opened.
892
Unsupported formats may not support initialization or committing or
893
some other features depending on the reason for not being supported.
894
"""
895
return True
896
897
def open(self, a_bzrdir, _found=False):
898
"""Return the branch object for a_bzrdir
899
900
_found is a private parameter, do not use it. It is used to indicate
901
if format probing has already be done.
902
"""
903
raise NotImplementedError(self.open)
904
905
@classmethod
906
def register_format(klass, format):
907
klass._formats[format.get_format_string()] = format
908
909
@classmethod
910
def set_default_format(klass, format):
911
klass._default_format = format
912
913
@classmethod
914
def unregister_format(klass, format):
915
assert klass._formats[format.get_format_string()] is format
916
del klass._formats[format.get_format_string()]
917
918
def __str__(self):
919
return self.get_format_string().rstrip()
920
921
def supports_tags(self):
922
"""True if this format supports tags stored in the branch"""
923
return False # by default
924
925
# XXX: Probably doesn't really belong here -- mbp 20070212
926
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
927
lock_class):
928
branch_transport = a_bzrdir.get_branch_transport(self)
929
control_files = lockable_files.LockableFiles(branch_transport,
930
lock_filename, lock_class)
931
control_files.create_lock()
932
control_files.lock_write()
933
try:
934
for filename, content in utf8_files:
935
control_files.put_utf8(filename, content)
936
finally:
937
control_files.unlock()
938
939
940
class BranchHooks(dict):
941
"""A dictionary mapping hook name to a list of callables for branch hooks.
942
943
e.g. ['set_rh'] Is the list of items to be called when the
944
set_revision_history function is invoked.
945
"""
946
947
def __init__(self):
948
"""Create the default hooks.
949
950
These are all empty initially, because by default nothing should get
951
notified.
952
"""
953
dict.__init__(self)
954
# Introduced in 0.15:
955
# invoked whenever the revision history has been set
956
# with set_revision_history. The api signature is
957
# (branch, revision_history), and the branch will
958
# be write-locked.
959
self['set_rh'] = []
960
# invoked after a push operation completes.
961
# the api signature is
962
# (push_result)
963
# containing the members
964
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
965
# where local is the local branch or None, master is the target
966
# master branch, and the rest should be self explanatory. The source
967
# is read locked and the target branches write locked. Source will
968
# be the local low-latency branch.
969
self['post_push'] = []
970
# invoked after a pull operation completes.
971
# the api signature is
972
# (pull_result)
973
# containing the members
974
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
975
# where local is the local branch or None, master is the target
976
# master branch, and the rest should be self explanatory. The source
977
# is read locked and the target branches write locked. The local
978
# branch is the low-latency branch.
979
self['post_pull'] = []
980
# invoked after a commit operation completes.
981
# the api signature is
982
# (local, master, old_revno, old_revid, new_revno, new_revid)
983
# old_revid is NULL_REVISION for the first commit to a branch.
984
self['post_commit'] = []
985
# invoked after a uncommit operation completes.
986
# the api signature is
987
# (local, master, old_revno, old_revid, new_revno, new_revid) where
988
# local is the local branch or None, master is the target branch,
989
# and an empty branch recieves new_revno of 0, new_revid of None.
990
self['post_uncommit'] = []
991
992
def install_hook(self, hook_name, a_callable):
993
"""Install a_callable in to the hook hook_name.
994
995
:param hook_name: A hook name. See the __init__ method of BranchHooks
996
for the complete list of hooks.
997
:param a_callable: The callable to be invoked when the hook triggers.
998
The exact signature will depend on the hook - see the __init__
999
method of BranchHooks for details on each hook.
1000
"""
1001
try:
1002
self[hook_name].append(a_callable)
1003
except KeyError:
1004
raise errors.UnknownHook('branch', hook_name)
1005
1006
1007
# install the default hooks into the Branch class.
1008
Branch.hooks = BranchHooks()
1009
1010
1011
class BzrBranchFormat4(BranchFormat):
1012
"""Bzr branch format 4.
1013
1014
This format has:
1015
- a revision-history file.
1016
- a branch-lock lock file [ to be shared with the bzrdir ]
1017
"""
1018
1019
def get_format_description(self):
1020
"""See BranchFormat.get_format_description()."""
1021
return "Branch format 4"
1022
1023
def initialize(self, a_bzrdir):
1024
"""Create a branch of this format in a_bzrdir."""
1025
utf8_files = [('revision-history', ''),
1026
('branch-name', ''),
1027
]
1028
return self._initialize_helper(a_bzrdir, utf8_files,
1029
lock_type='branch4', set_format=False)
1030
1031
def __init__(self):
1032
super(BzrBranchFormat4, self).__init__()
1033
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1034
1035
def open(self, a_bzrdir, _found=False):
1036
"""Return the branch object for a_bzrdir
1037
1038
_found is a private parameter, do not use it. It is used to indicate
1039
if format probing has already be done.
1040
"""
1041
if not _found:
1042
# we are being called directly and must probe.
1043
raise NotImplementedError
1044
return BzrBranch(_format=self,
1045
_control_files=a_bzrdir._control_files,
1046
a_bzrdir=a_bzrdir,
1047
_repository=a_bzrdir.open_repository())
1048
1049
def __str__(self):
1050
return "Bazaar-NG branch format 4"
1051
1052
1053
class BzrBranchFormat5(BranchFormat):
1054
"""Bzr branch format 5.
1055
1056
This format has:
1057
- a revision-history file.
1058
- a format string
1059
- a lock dir guarding the branch itself
1060
- all of this stored in a branch/ subdirectory
1061
- works with shared repositories.
1062
1063
This format is new in bzr 0.8.
1064
"""
1065
1066
def get_format_string(self):
1067
"""See BranchFormat.get_format_string()."""
1068
return "Bazaar-NG branch format 5\n"
1069
1070
def get_format_description(self):
1071
"""See BranchFormat.get_format_description()."""
1072
return "Branch format 5"
1073
1074
def initialize(self, a_bzrdir):
1075
"""Create a branch of this format in a_bzrdir."""
1076
utf8_files = [('revision-history', ''),
1077
('branch-name', ''),
1078
]
1079
return self._initialize_helper(a_bzrdir, utf8_files)
1080
1081
def __init__(self):
1082
super(BzrBranchFormat5, self).__init__()
1083
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1084
1085
def open(self, a_bzrdir, _found=False):
1086
"""Return the branch object for a_bzrdir
1087
1088
_found is a private parameter, do not use it. It is used to indicate
1089
if format probing has already be done.
1090
"""
1091
if not _found:
1092
format = BranchFormat.find_format(a_bzrdir)
1093
assert format.__class__ == self.__class__
1094
transport = a_bzrdir.get_branch_transport(None)
1095
control_files = lockable_files.LockableFiles(transport, 'lock',
1096
lockdir.LockDir)
1097
return BzrBranch5(_format=self,
1098
_control_files=control_files,
1099
a_bzrdir=a_bzrdir,
1100
_repository=a_bzrdir.find_repository())
1101
1102
1103
class BzrBranchFormat6(BzrBranchFormat5):
1104
"""Branch format with last-revision
1105
1106
Unlike previous formats, this has no explicit revision history. Instead,
1107
this just stores the last-revision, and the left-hand history leading
1108
up to there is the history.
1109
1110
This format was introduced in bzr 0.15
1111
"""
1112
1113
def get_format_string(self):
1114
"""See BranchFormat.get_format_string()."""
1115
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1116
1117
def get_format_description(self):
1118
"""See BranchFormat.get_format_description()."""
1119
return "Branch format 6"
1120
1121
def initialize(self, a_bzrdir):
1122
"""Create a branch of this format in a_bzrdir."""
1123
utf8_files = [('last-revision', '0 null:\n'),
1124
('branch-name', ''),
1125
('branch.conf', ''),
1126
('tags', ''),
1127
]
1128
return self._initialize_helper(a_bzrdir, utf8_files)
1129
1130
def open(self, a_bzrdir, _found=False):
1131
"""Return the branch object for a_bzrdir
1132
1133
_found is a private parameter, do not use it. It is used to indicate
1134
if format probing has already be done.
1135
"""
1136
if not _found:
1137
format = BranchFormat.find_format(a_bzrdir)
1138
assert format.__class__ == self.__class__
1139
transport = a_bzrdir.get_branch_transport(None)
1140
control_files = lockable_files.LockableFiles(transport, 'lock',
1141
lockdir.LockDir)
1142
return BzrBranch6(_format=self,
1143
_control_files=control_files,
1144
a_bzrdir=a_bzrdir,
1145
_repository=a_bzrdir.find_repository())
1146
1147
def supports_tags(self):
1148
return True
1149
1150
1151
class BranchReferenceFormat(BranchFormat):
1152
"""Bzr branch reference format.
1153
1154
Branch references are used in implementing checkouts, they
1155
act as an alias to the real branch which is at some other url.
1156
1157
This format has:
1158
- A location file
1159
- a format string
1160
"""
1161
1162
def get_format_string(self):
1163
"""See BranchFormat.get_format_string()."""
1164
return "Bazaar-NG Branch Reference Format 1\n"
1165
1166
def get_format_description(self):
1167
"""See BranchFormat.get_format_description()."""
1168
return "Checkout reference format 1"
1169
1170
def initialize(self, a_bzrdir, target_branch=None):
1171
"""Create a branch of this format in a_bzrdir."""
1172
if target_branch is None:
1173
# this format does not implement branch itself, thus the implicit
1174
# creation contract must see it as uninitializable
1175
raise errors.UninitializableFormat(self)
1176
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1177
branch_transport = a_bzrdir.get_branch_transport(self)
1178
branch_transport.put_bytes('location',
1179
target_branch.bzrdir.root_transport.base)
1180
branch_transport.put_bytes('format', self.get_format_string())
1181
return self.open(a_bzrdir, _found=True)
1182
1183
def __init__(self):
1184
super(BranchReferenceFormat, self).__init__()
1185
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1186
1187
def _make_reference_clone_function(format, a_branch):
1188
"""Create a clone() routine for a branch dynamically."""
1189
def clone(to_bzrdir, revision_id=None):
1190
"""See Branch.clone()."""
1191
return format.initialize(to_bzrdir, a_branch)
1192
# cannot obey revision_id limits when cloning a reference ...
1193
# FIXME RBC 20060210 either nuke revision_id for clone, or
1194
# emit some sort of warning/error to the caller ?!
1195
return clone
1196
1197
def open(self, a_bzrdir, _found=False):
1198
"""Return the branch that the branch reference in a_bzrdir points at.
1199
1200
_found is a private parameter, do not use it. It is used to indicate
1201
if format probing has already be done.
1202
"""
1203
if not _found:
1204
format = BranchFormat.find_format(a_bzrdir)
1205
assert format.__class__ == self.__class__
1206
transport = a_bzrdir.get_branch_transport(None)
1207
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1208
result = real_bzrdir.open_branch()
1209
# this changes the behaviour of result.clone to create a new reference
1210
# rather than a copy of the content of the branch.
1211
# I did not use a proxy object because that needs much more extensive
1212
# testing, and we are only changing one behaviour at the moment.
1213
# If we decide to alter more behaviours - i.e. the implicit nickname
1214
# then this should be refactored to introduce a tested proxy branch
1215
# and a subclass of that for use in overriding clone() and ....
1216
# - RBC 20060210
1217
result.clone = self._make_reference_clone_function(result)
1218
return result
1219
1220
1221
# formats which have no format string are not discoverable
1222
# and not independently creatable, so are not registered.
1223
__default_format = BzrBranchFormat5()
1224
BranchFormat.register_format(__default_format)
1225
BranchFormat.register_format(BranchReferenceFormat())
1226
BranchFormat.register_format(BzrBranchFormat6())
1227
BranchFormat.set_default_format(__default_format)
1228
_legacy_formats = [BzrBranchFormat4(),
1229
]
1230
1231
class BzrBranch(Branch):
1232
"""A branch stored in the actual filesystem.
1233
1234
Note that it's "local" in the context of the filesystem; it doesn't
1235
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1236
it's writable, and can be accessed via the normal filesystem API.
1237
"""
1238
1239
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1240
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1241
_control_files=None, a_bzrdir=None, _repository=None):
1242
"""Create new branch object at a particular location.
1243
1244
transport -- A Transport object, defining how to access files.
1245
1246
init -- If True, create new control files in a previously
1247
unversioned directory. If False, the branch must already
1248
be versioned.
1249
1250
relax_version_check -- If true, the usual check for the branch
1251
version is not applied. This is intended only for
1252
upgrade/recovery type use; it's not guaranteed that
1253
all operations will work on old format branches.
1254
"""
1255
Branch.__init__(self)
1256
if a_bzrdir is None:
1257
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1258
else:
1259
self.bzrdir = a_bzrdir
1260
# self._transport used to point to the directory containing the
1261
# control directory, but was not used - now it's just the transport
1262
# for the branch control files. mbp 20070212
1263
self._base = self.bzrdir.transport.clone('..').base
1264
self._format = _format
1265
if _control_files is None:
1266
raise ValueError('BzrBranch _control_files is None')
1267
self.control_files = _control_files
1268
self._transport = _control_files._transport
1269
if deprecated_passed(init):
1270
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1271
"deprecated as of bzr 0.8. Please use Branch.create().",
1272
DeprecationWarning,
1273
stacklevel=2)
1274
if init:
1275
# this is slower than before deprecation, oh well never mind.
1276
# -> its deprecated.
1277
self._initialize(transport.base)
1278
self._check_format(_format)
1279
if deprecated_passed(relax_version_check):
1280
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1281
"relax_version_check parameter is deprecated as of bzr 0.8. "
1282
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1283
"open() method.",
1284
DeprecationWarning,
1285
stacklevel=2)
1286
if (not relax_version_check
1287
and not self._format.is_supported()):
1288
raise errors.UnsupportedFormatError(format=fmt)
1289
if deprecated_passed(transport):
1290
warn("BzrBranch.__init__(transport=XXX...): The transport "
1291
"parameter is deprecated as of bzr 0.8. "
1292
"Please use Branch.open, or bzrdir.open_branch().",
1293
DeprecationWarning,
1294
stacklevel=2)
1295
self.repository = _repository
1296
1297
def __str__(self):
1298
return '%s(%r)' % (self.__class__.__name__, self.base)
1299
1300
__repr__ = __str__
1301
1302
def _get_base(self):
1303
"""Returns the directory containing the control directory."""
1304
return self._base
1305
1306
base = property(_get_base, doc="The URL for the root of this branch.")
1307
1308
def abspath(self, name):
1309
"""See Branch.abspath."""
1310
return self.control_files._transport.abspath(name)
1311
1312
def _check_format(self, format):
1313
"""Identify the branch format if needed.
1314
1315
The format is stored as a reference to the format object in
1316
self._format for code that needs to check it later.
1317
1318
The format parameter is either None or the branch format class
1319
used to open this branch.
1320
1321
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1322
"""
1323
if format is None:
1324
format = BranchFormat.find_format(self.bzrdir)
1325
self._format = format
1326
mutter("got branch format %s", self._format)
1327
1328
@deprecated_method(zero_sixteen)
1329
@needs_read_lock
1330
def get_root_id(self):
1331
"""See Branch.get_root_id."""
1332
tree = self.repository.revision_tree(self.last_revision())
1333
return tree.inventory.root.file_id
1334
1335
def is_locked(self):
1336
return self.control_files.is_locked()
1337
1338
def lock_write(self):
1339
self.repository.lock_write()
1340
try:
1341
self.control_files.lock_write()
1342
except:
1343
self.repository.unlock()
1344
raise
1345
1346
def lock_read(self):
1347
self.repository.lock_read()
1348
try:
1349
self.control_files.lock_read()
1350
except:
1351
self.repository.unlock()
1352
raise
1353
1354
def unlock(self):
1355
# TODO: test for failed two phase locks. This is known broken.
1356
try:
1357
self.control_files.unlock()
1358
finally:
1359
self.repository.unlock()
1360
if not self.control_files.is_locked():
1361
# we just released the lock
1362
self._clear_cached_state()
1363
1364
def peek_lock_mode(self):
1365
if self.control_files._lock_count == 0:
1366
return None
1367
else:
1368
return self.control_files._lock_mode
1369
1370
def get_physical_lock_status(self):
1371
return self.control_files.get_physical_lock_status()
1372
1373
@needs_read_lock
1374
def print_file(self, file, revision_id):
1375
"""See Branch.print_file."""
1376
return self.repository.print_file(file, revision_id)
1377
1378
@needs_write_lock
1379
def append_revision(self, *revision_ids):
1380
"""See Branch.append_revision."""
1381
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1382
for revision_id in revision_ids:
1383
_mod_revision.check_not_reserved_id(revision_id)
1384
mutter("add {%s} to revision-history" % revision_id)
1385
rev_history = self.revision_history()
1386
rev_history.extend(revision_ids)
1387
self.set_revision_history(rev_history)
1388
1389
def _write_revision_history(self, history):
1390
"""Factored out of set_revision_history.
1391
1392
This performs the actual writing to disk.
1393
It is intended to be called by BzrBranch5.set_revision_history."""
1394
self.control_files.put_bytes(
1395
'revision-history', '\n'.join(history))
1396
1397
@needs_write_lock
1398
def set_revision_history(self, rev_history):
1399
"""See Branch.set_revision_history."""
1400
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1401
self._write_revision_history(rev_history)
1402
self._cache_revision_history(rev_history)
1403
for hook in Branch.hooks['set_rh']:
1404
hook(self, rev_history)
1405
1406
@needs_write_lock
1407
def set_last_revision_info(self, revno, revision_id):
1408
revision_id = osutils.safe_revision_id(revision_id)
1409
history = self._lefthand_history(revision_id)
1410
assert len(history) == revno, '%d != %d' % (len(history), revno)
1411
self.set_revision_history(history)
1412
1413
def _gen_revision_history(self):
1414
history = self.control_files.get('revision-history').read().split('\n')
1415
if history[-1:] == ['']:
1416
# There shouldn't be a trailing newline, but just in case.
1417
history.pop()
1418
return history
1419
1420
def _lefthand_history(self, revision_id, last_rev=None,
1421
other_branch=None):
1422
# stop_revision must be a descendant of last_revision
1423
stop_graph = self.repository.get_revision_graph(revision_id)
1424
if last_rev is not None and last_rev not in stop_graph:
1425
# our previous tip is not merged into stop_revision
1426
raise errors.DivergedBranches(self, other_branch)
1427
# make a new revision history from the graph
1428
current_rev_id = revision_id
1429
new_history = []
1430
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1431
new_history.append(current_rev_id)
1432
current_rev_id_parents = stop_graph[current_rev_id]
1433
try:
1434
current_rev_id = current_rev_id_parents[0]
1435
except IndexError:
1436
current_rev_id = None
1437
new_history.reverse()
1438
return new_history
1439
1440
@needs_write_lock
1441
def generate_revision_history(self, revision_id, last_rev=None,
1442
other_branch=None):
1443
"""Create a new revision history that will finish with revision_id.
1444
1445
:param revision_id: the new tip to use.
1446
:param last_rev: The previous last_revision. If not None, then this
1447
must be a ancestory of revision_id, or DivergedBranches is raised.
1448
:param other_branch: The other branch that DivergedBranches should
1449
raise with respect to.
1450
"""
1451
revision_id = osutils.safe_revision_id(revision_id)
1452
self.set_revision_history(self._lefthand_history(revision_id,
1453
last_rev, other_branch))
1454
1455
@needs_write_lock
1456
def update_revisions(self, other, stop_revision=None):
1457
"""See Branch.update_revisions."""
1458
other.lock_read()
1459
try:
1460
if stop_revision is None:
1461
stop_revision = other.last_revision()
1462
if stop_revision is None:
1463
# if there are no commits, we're done.
1464
return
1465
else:
1466
stop_revision = osutils.safe_revision_id(stop_revision)
1467
# whats the current last revision, before we fetch [and change it
1468
# possibly]
1469
last_rev = self.last_revision()
1470
# we fetch here regardless of whether we need to so that we pickup
1471
# filled in ghosts.
1472
self.fetch(other, stop_revision)
1473
my_ancestry = self.repository.get_ancestry(last_rev)
1474
if stop_revision in my_ancestry:
1475
# last_revision is a descendant of stop_revision
1476
return
1477
self.generate_revision_history(stop_revision, last_rev=last_rev,
1478
other_branch=other)
1479
finally:
1480
other.unlock()
1481
1482
def basis_tree(self):
1483
"""See Branch.basis_tree."""
1484
return self.repository.revision_tree(self.last_revision())
1485
1486
@deprecated_method(zero_eight)
1487
def working_tree(self):
1488
"""Create a Working tree object for this branch."""
1489
1490
from bzrlib.transport.local import LocalTransport
1491
if (self.base.find('://') != -1 or
1492
not isinstance(self._transport, LocalTransport)):
1493
raise NoWorkingTree(self.base)
1494
return self.bzrdir.open_workingtree()
1495
1496
@needs_write_lock
1497
def pull(self, source, overwrite=False, stop_revision=None,
1498
_hook_master=None, _run_hooks=True):
1499
"""See Branch.pull.
1500
1501
:param _hook_master: Private parameter - set the branch to
1502
be supplied as the master to push hooks.
1503
:param _run_hooks: Private parameter - allow disabling of
1504
hooks, used when pushing to a master branch.
1505
"""
1506
result = PullResult()
1507
result.source_branch = source
1508
result.target_branch = self
1509
source.lock_read()
1510
try:
1511
result.old_revno, result.old_revid = self.last_revision_info()
1512
try:
1513
self.update_revisions(source, stop_revision)
1514
except DivergedBranches:
1515
if not overwrite:
1516
raise
1517
if overwrite:
1518
if stop_revision is None:
1519
stop_revision = source.last_revision()
1520
self.generate_revision_history(stop_revision)
1521
result.tag_conflicts = source.tags.merge_to(self.tags)
1522
result.new_revno, result.new_revid = self.last_revision_info()
1523
if _hook_master:
1524
result.master_branch = _hook_master
1525
result.local_branch = self
1526
else:
1527
result.master_branch = self
1528
result.local_branch = None
1529
if _run_hooks:
1530
for hook in Branch.hooks['post_pull']:
1531
hook(result)
1532
finally:
1533
source.unlock()
1534
return result
1535
1536
def _get_parent_location(self):
1537
_locs = ['parent', 'pull', 'x-pull']
1538
for l in _locs:
1539
try:
1540
return self.control_files.get(l).read().strip('\n')
1541
except NoSuchFile:
1542
pass
1543
return None
1544
1545
@needs_read_lock
1546
def push(self, target, overwrite=False, stop_revision=None,
1547
_hook_master=None, _run_hooks=True):
1548
"""See Branch.push.
1549
1550
:param _hook_master: Private parameter - set the branch to
1551
be supplied as the master to push hooks.
1552
:param _run_hooks: Private parameter - allow disabling of
1553
hooks, used when pushing to a master branch.
1554
"""
1555
result = PushResult()
1556
result.source_branch = self
1557
result.target_branch = target
1558
target.lock_write()
1559
try:
1560
result.old_revno, result.old_revid = target.last_revision_info()
1561
try:
1562
target.update_revisions(self, stop_revision)
1563
except DivergedBranches:
1564
if not overwrite:
1565
raise
1566
if overwrite:
1567
target.set_revision_history(self.revision_history())
1568
result.tag_conflicts = self.tags.merge_to(target.tags)
1569
result.new_revno, result.new_revid = target.last_revision_info()
1570
if _hook_master:
1571
result.master_branch = _hook_master
1572
result.local_branch = target
1573
else:
1574
result.master_branch = target
1575
result.local_branch = None
1576
if _run_hooks:
1577
for hook in Branch.hooks['post_push']:
1578
hook(result)
1579
finally:
1580
target.unlock()
1581
return result
1582
1583
def get_parent(self):
1584
"""See Branch.get_parent."""
1585
1586
assert self.base[-1] == '/'
1587
parent = self._get_parent_location()
1588
if parent is None:
1589
return parent
1590
# This is an old-format absolute path to a local branch
1591
# turn it into a url
1592
if parent.startswith('/'):
1593
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1594
try:
1595
return urlutils.join(self.base[:-1], parent)
1596
except errors.InvalidURLJoin, e:
1597
raise errors.InaccessibleParent(parent, self.base)
1598
1599
def get_push_location(self):
1600
"""See Branch.get_push_location."""
1601
push_loc = self.get_config().get_user_option('push_location')
1602
return push_loc
1603
1604
def set_push_location(self, location):
1605
"""See Branch.set_push_location."""
1606
self.get_config().set_user_option(
1607
'push_location', location,
1608
store=_mod_config.STORE_LOCATION_NORECURSE)
1609
1610
@needs_write_lock
1611
def set_parent(self, url):
1612
"""See Branch.set_parent."""
1613
# TODO: Maybe delete old location files?
1614
# URLs should never be unicode, even on the local fs,
1615
# FIXUP this and get_parent in a future branch format bump:
1616
# read and rewrite the file, and have the new format code read
1617
# using .get not .get_utf8. RBC 20060125
1618
if url is not None:
1619
if isinstance(url, unicode):
1620
try:
1621
url = url.encode('ascii')
1622
except UnicodeEncodeError:
1623
raise bzrlib.errors.InvalidURL(url,
1624
"Urls must be 7-bit ascii, "
1625
"use bzrlib.urlutils.escape")
1626
url = urlutils.relative_url(self.base, url)
1627
self._set_parent_location(url)
1628
1629
def _set_parent_location(self, url):
1630
if url is None:
1631
self.control_files._transport.delete('parent')
1632
else:
1633
assert isinstance(url, str)
1634
self.control_files.put_bytes('parent', url + '\n')
1635
1636
@deprecated_function(zero_nine)
1637
def tree_config(self):
1638
"""DEPRECATED; call get_config instead.
1639
TreeConfig has become part of BranchConfig."""
1640
return TreeConfig(self)
1641
1642
1643
class BzrBranch5(BzrBranch):
1644
"""A format 5 branch. This supports new features over plan branches.
1645
1646
It has support for a master_branch which is the data for bound branches.
1647
"""
1648
1649
def __init__(self,
1650
_format,
1651
_control_files,
1652
a_bzrdir,
1653
_repository):
1654
super(BzrBranch5, self).__init__(_format=_format,
1655
_control_files=_control_files,
1656
a_bzrdir=a_bzrdir,
1657
_repository=_repository)
1658
1659
@needs_write_lock
1660
def pull(self, source, overwrite=False, stop_revision=None,
1661
_run_hooks=True):
1662
"""Extends branch.pull to be bound branch aware.
1663
1664
:param _run_hooks: Private parameter used to force hook running
1665
off during bound branch double-pushing.
1666
"""
1667
bound_location = self.get_bound_location()
1668
master_branch = None
1669
if bound_location and source.base != bound_location:
1670
# not pulling from master, so we need to update master.
1671
master_branch = self.get_master_branch()
1672
master_branch.lock_write()
1673
try:
1674
if master_branch:
1675
# pull from source into master.
1676
master_branch.pull(source, overwrite, stop_revision,
1677
_run_hooks=False)
1678
return super(BzrBranch5, self).pull(source, overwrite,
1679
stop_revision, _hook_master=master_branch,
1680
_run_hooks=_run_hooks)
1681
finally:
1682
if master_branch:
1683
master_branch.unlock()
1684
1685
@needs_read_lock
1686
def push(self, target, overwrite=False, stop_revision=None):
1687
"""Updates branch.push to be bound branch aware."""
1688
bound_location = target.get_bound_location()
1689
master_branch = None
1690
if bound_location and target.base != bound_location:
1691
# not pushing to master, so we need to update master.
1692
master_branch = target.get_master_branch()
1693
master_branch.lock_write()
1694
try:
1695
if master_branch:
1696
# push into the master from this branch.
1697
super(BzrBranch5, self).push(master_branch, overwrite,
1698
stop_revision, _run_hooks=False)
1699
# and push into the target branch from this. Note that we push from
1700
# this branch again, because its considered the highest bandwidth
1701
# repository.
1702
return super(BzrBranch5, self).push(target, overwrite,
1703
stop_revision, _hook_master=master_branch)
1704
finally:
1705
if master_branch:
1706
master_branch.unlock()
1707
1708
def get_bound_location(self):
1709
try:
1710
return self.control_files.get_utf8('bound').read()[:-1]
1711
except errors.NoSuchFile:
1712
return None
1713
1714
@needs_read_lock
1715
def get_master_branch(self):
1716
"""Return the branch we are bound to.
1717
1718
:return: Either a Branch, or None
1719
1720
This could memoise the branch, but if thats done
1721
it must be revalidated on each new lock.
1722
So for now we just don't memoise it.
1723
# RBC 20060304 review this decision.
1724
"""
1725
bound_loc = self.get_bound_location()
1726
if not bound_loc:
1727
return None
1728
try:
1729
return Branch.open(bound_loc)
1730
except (errors.NotBranchError, errors.ConnectionError), e:
1731
raise errors.BoundBranchConnectionFailure(
1732
self, bound_loc, e)
1733
1734
@needs_write_lock
1735
def set_bound_location(self, location):
1736
"""Set the target where this branch is bound to.
1737
1738
:param location: URL to the target branch
1739
"""
1740
if location:
1741
self.control_files.put_utf8('bound', location+'\n')
1742
else:
1743
try:
1744
self.control_files._transport.delete('bound')
1745
except NoSuchFile:
1746
return False
1348
1747
return True
1349
if filename == head:
1350
break
1351
filename = head
1352
return False
1353
1354
1355
1356
def gen_file_id(name):
1357
"""Return new file id.
1358
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1361
slow."""
1362
import re
1363
from binascii import hexlify
1364
from time import time
1365
1366
# get last component
1367
idx = name.rfind('/')
1368
if idx != -1:
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1371
if idx != -1:
1372
name = name[idx+1 : ]
1373
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1376
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1380
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1383
1384
1385
def gen_root_id():
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
1388
1748
1749
@needs_write_lock
1750
def bind(self, other):
1751
"""Bind this branch to the branch other.
1752
1753
This does not push or pull data between the branches, though it does
1754
check for divergence to raise an error when the branches are not
1755
either the same, or one a prefix of the other. That behaviour may not
1756
be useful, so that check may be removed in future.
1757
1758
:param other: The branch to bind to
1759
:type other: Branch
1760
"""
1761
# TODO: jam 20051230 Consider checking if the target is bound
1762
# It is debatable whether you should be able to bind to
1763
# a branch which is itself bound.
1764
# Committing is obviously forbidden,
1765
# but binding itself may not be.
1766
# Since we *have* to check at commit time, we don't
1767
# *need* to check here
1768
1769
# we want to raise diverged if:
1770
# last_rev is not in the other_last_rev history, AND
1771
# other_last_rev is not in our history, and do it without pulling
1772
# history around
1773
last_rev = self.last_revision()
1774
if last_rev is not None:
1775
other.lock_read()
1776
try:
1777
other_last_rev = other.last_revision()
1778
if other_last_rev is not None:
1779
# neither branch is new, we have to do some work to
1780
# ascertain diversion.
1781
remote_graph = other.repository.get_revision_graph(
1782
other_last_rev)
1783
local_graph = self.repository.get_revision_graph(last_rev)
1784
if (last_rev not in remote_graph and
1785
other_last_rev not in local_graph):
1786
raise errors.DivergedBranches(self, other)
1787
finally:
1788
other.unlock()
1789
self.set_bound_location(other.base)
1790
1791
@needs_write_lock
1792
def unbind(self):
1793
"""If bound, unbind"""
1794
return self.set_bound_location(None)
1795
1796
@needs_write_lock
1797
def update(self):
1798
"""Synchronise this branch with the master branch if any.
1799
1800
:return: None or the last_revision that was pivoted out during the
1801
update.
1802
"""
1803
master = self.get_master_branch()
1804
if master is not None:
1805
old_tip = self.last_revision()
1806
self.pull(master, overwrite=True)
1807
if old_tip in self.repository.get_ancestry(self.last_revision()):
1808
return None
1809
return old_tip
1810
return None
1811
1812
1813
class BzrBranchExperimental(BzrBranch5):
1814
"""Bzr experimental branch format
1815
1816
This format has:
1817
- a revision-history file.
1818
- a format string
1819
- a lock dir guarding the branch itself
1820
- all of this stored in a branch/ subdirectory
1821
- works with shared repositories.
1822
- a tag dictionary in the branch
1823
1824
This format is new in bzr 0.15, but shouldn't be used for real data,
1825
only for testing.
1826
1827
This class acts as it's own BranchFormat.
1828
"""
1829
1830
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1831
1832
@classmethod
1833
def get_format_string(cls):
1834
"""See BranchFormat.get_format_string()."""
1835
return "Bazaar-NG branch format experimental\n"
1836
1837
@classmethod
1838
def get_format_description(cls):
1839
"""See BranchFormat.get_format_description()."""
1840
return "Experimental branch format"
1841
1842
@classmethod
1843
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1844
lock_class):
1845
branch_transport = a_bzrdir.get_branch_transport(cls)
1846
control_files = lockable_files.LockableFiles(branch_transport,
1847
lock_filename, lock_class)
1848
control_files.create_lock()
1849
control_files.lock_write()
1850
try:
1851
for filename, content in utf8_files:
1852
control_files.put_utf8(filename, content)
1853
finally:
1854
control_files.unlock()
1855
1856
@classmethod
1857
def initialize(cls, a_bzrdir):
1858
"""Create a branch of this format in a_bzrdir."""
1859
utf8_files = [('format', cls.get_format_string()),
1860
('revision-history', ''),
1861
('branch-name', ''),
1862
('tags', ''),
1863
]
1864
cls._initialize_control_files(a_bzrdir, utf8_files,
1865
'lock', lockdir.LockDir)
1866
return cls.open(a_bzrdir, _found=True)
1867
1868
@classmethod
1869
def open(cls, a_bzrdir, _found=False):
1870
"""Return the branch object for a_bzrdir
1871
1872
_found is a private parameter, do not use it. It is used to indicate
1873
if format probing has already be done.
1874
"""
1875
if not _found:
1876
format = BranchFormat.find_format(a_bzrdir)
1877
assert format.__class__ == cls
1878
transport = a_bzrdir.get_branch_transport(None)
1879
control_files = lockable_files.LockableFiles(transport, 'lock',
1880
lockdir.LockDir)
1881
return cls(_format=cls,
1882
_control_files=control_files,
1883
a_bzrdir=a_bzrdir,
1884
_repository=a_bzrdir.find_repository())
1885
1886
@classmethod
1887
def is_supported(cls):
1888
return True
1889
1890
def _make_tags(self):
1891
return BasicTags(self)
1892
1893
@classmethod
1894
def supports_tags(cls):
1895
return True
1896
1897
1898
BranchFormat.register_format(BzrBranchExperimental)
1899
1900
1901
class BzrBranch6(BzrBranch5):
1902
1903
@needs_read_lock
1904
def last_revision_info(self):
1905
revision_string = self.control_files.get('last-revision').read()
1906
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1907
revision_id = cache_utf8.get_cached_utf8(revision_id)
1908
revno = int(revno)
1909
return revno, revision_id
1910
1911
def last_revision(self):
1912
"""Return last revision id, or None"""
1913
revision_id = self.last_revision_info()[1]
1914
if revision_id == _mod_revision.NULL_REVISION:
1915
revision_id = None
1916
return revision_id
1917
1918
def _write_last_revision_info(self, revno, revision_id):
1919
"""Simply write out the revision id, with no checks.
1920
1921
Use set_last_revision_info to perform this safely.
1922
1923
Does not update the revision_history cache.
1924
Intended to be called by set_last_revision_info and
1925
_write_revision_history.
1926
"""
1927
if revision_id is None:
1928
revision_id = 'null:'
1929
out_string = '%d %s\n' % (revno, revision_id)
1930
self.control_files.put_bytes('last-revision', out_string)
1931
1932
@needs_write_lock
1933
def set_last_revision_info(self, revno, revision_id):
1934
revision_id = osutils.safe_revision_id(revision_id)
1935
if self._get_append_revisions_only():
1936
self._check_history_violation(revision_id)
1937
self._write_last_revision_info(revno, revision_id)
1938
self._clear_cached_state()
1939
1940
def _check_history_violation(self, revision_id):
1941
last_revision = self.last_revision()
1942
if last_revision is None:
1943
return
1944
if last_revision not in self._lefthand_history(revision_id):
1945
raise errors.AppendRevisionsOnlyViolation(self.base)
1946
1947
def _gen_revision_history(self):
1948
"""Generate the revision history from last revision
1949
"""
1950
history = list(self.repository.iter_reverse_revision_history(
1951
self.last_revision()))
1952
history.reverse()
1953
return history
1954
1955
def _write_revision_history(self, history):
1956
"""Factored out of set_revision_history.
1957
1958
This performs the actual writing to disk, with format-specific checks.
1959
It is intended to be called by BzrBranch5.set_revision_history.
1960
"""
1961
if len(history) == 0:
1962
last_revision = 'null:'
1963
else:
1964
if history != self._lefthand_history(history[-1]):
1965
raise errors.NotLefthandHistory(history)
1966
last_revision = history[-1]
1967
if self._get_append_revisions_only():
1968
self._check_history_violation(last_revision)
1969
self._write_last_revision_info(len(history), last_revision)
1970
1971
@needs_write_lock
1972
def append_revision(self, *revision_ids):
1973
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1974
if len(revision_ids) == 0:
1975
return
1976
prev_revno, prev_revision = self.last_revision_info()
1977
for revision in self.repository.get_revisions(revision_ids):
1978
if prev_revision == _mod_revision.NULL_REVISION:
1979
if revision.parent_ids != []:
1980
raise errors.NotLeftParentDescendant(self, prev_revision,
1981
revision.revision_id)
1982
else:
1983
if revision.parent_ids[0] != prev_revision:
1984
raise errors.NotLeftParentDescendant(self, prev_revision,
1985
revision.revision_id)
1986
prev_revision = revision.revision_id
1987
self.set_last_revision_info(prev_revno + len(revision_ids),
1988
revision_ids[-1])
1989
1990
@needs_write_lock
1991
def _set_parent_location(self, url):
1992
"""Set the parent branch"""
1993
self._set_config_location('parent_location', url, make_relative=True)
1994
1995
@needs_read_lock
1996
def _get_parent_location(self):
1997
"""Set the parent branch"""
1998
return self._get_config_location('parent_location')
1999
2000
def set_push_location(self, location):
2001
"""See Branch.set_push_location."""
2002
self._set_config_location('push_location', location)
2003
2004
def set_bound_location(self, location):
2005
"""See Branch.set_push_location."""
2006
result = None
2007
config = self.get_config()
2008
if location is None:
2009
if config.get_user_option('bound') != 'True':
2010
return False
2011
else:
2012
config.set_user_option('bound', 'False')
2013
return True
2014
else:
2015
self._set_config_location('bound_location', location,
2016
config=config)
2017
config.set_user_option('bound', 'True')
2018
return True
2019
2020
def _get_bound_location(self, bound):
2021
"""Return the bound location in the config file.
2022
2023
Return None if the bound parameter does not match"""
2024
config = self.get_config()
2025
config_bound = (config.get_user_option('bound') == 'True')
2026
if config_bound != bound:
2027
return None
2028
return self._get_config_location('bound_location', config=config)
2029
2030
def get_bound_location(self):
2031
"""See Branch.set_push_location."""
2032
return self._get_bound_location(True)
2033
2034
def get_old_bound_location(self):
2035
"""See Branch.get_old_bound_location"""
2036
return self._get_bound_location(False)
2037
2038
def set_append_revisions_only(self, enabled):
2039
if enabled:
2040
value = 'True'
2041
else:
2042
value = 'False'
2043
self.get_config().set_user_option('append_revisions_only', value)
2044
2045
def _get_append_revisions_only(self):
2046
value = self.get_config().get_user_option('append_revisions_only')
2047
return value == 'True'
2048
2049
def _synchronize_history(self, destination, revision_id):
2050
"""Synchronize last revision and revision history between branches.
2051
2052
This version is most efficient when the destination is also a
2053
BzrBranch6, but works for BzrBranch5, as long as the destination's
2054
repository contains all the lefthand ancestors of the intended
2055
last_revision. If not, set_last_revision_info will fail.
2056
2057
:param destination: The branch to copy the history into
2058
:param revision_id: The revision-id to truncate history at. May
2059
be None to copy complete history.
2060
"""
2061
if revision_id is None:
2062
revno, revision_id = self.last_revision_info()
2063
else:
2064
revno = self.revision_id_to_revno(revision_id)
2065
destination.set_last_revision_info(revno, revision_id)
2066
2067
def _make_tags(self):
2068
return BasicTags(self)
2069
2070
2071
class BranchTestProviderAdapter(object):
2072
"""A tool to generate a suite testing multiple branch formats at once.
2073
2074
This is done by copying the test once for each transport and injecting
2075
the transport_server, transport_readonly_server, and branch_format
2076
classes into each copy. Each copy is also given a new id() to make it
2077
easy to identify.
2078
"""
2079
2080
def __init__(self, transport_server, transport_readonly_server, formats):
2081
self._transport_server = transport_server
2082
self._transport_readonly_server = transport_readonly_server
2083
self._formats = formats
2084
2085
def adapt(self, test):
2086
result = TestSuite()
2087
for branch_format, bzrdir_format in self._formats:
2088
new_test = deepcopy(test)
2089
new_test.transport_server = self._transport_server
2090
new_test.transport_readonly_server = self._transport_readonly_server
2091
new_test.bzrdir_format = bzrdir_format
2092
new_test.branch_format = branch_format
2093
def make_new_test_id():
2094
# the format can be either a class or an instance
2095
name = getattr(branch_format, '__name__',
2096
branch_format.__class__.__name__)
2097
new_id = "%s(%s)" % (new_test.id(), name)
2098
return lambda: new_id
2099
new_test.id = make_new_test_id()
2100
result.addTest(new_test)
2101
return result
2102
2103
2104
######################################################################
2105
# results of operations
2106
2107
2108
class _Result(object):
2109
2110
def _show_tag_conficts(self, to_file):
2111
if not getattr(self, 'tag_conflicts', None):
2112
return
2113
to_file.write('Conflicting tags:\n')
2114
for name, value1, value2 in self.tag_conflicts:
2115
to_file.write(' %s\n' % (name, ))
2116
2117
2118
class PullResult(_Result):
2119
"""Result of a Branch.pull operation.
2120
2121
:ivar old_revno: Revision number before pull.
2122
:ivar new_revno: Revision number after pull.
2123
:ivar old_revid: Tip revision id before pull.
2124
:ivar new_revid: Tip revision id after pull.
2125
:ivar source_branch: Source (local) branch object.
2126
:ivar master_branch: Master branch of the target, or None.
2127
:ivar target_branch: Target/destination branch object.
2128
"""
2129
2130
def __int__(self):
2131
# DEPRECATED: pull used to return the change in revno
2132
return self.new_revno - self.old_revno
2133
2134
def report(self, to_file):
2135
if self.old_revid == self.new_revid:
2136
to_file.write('No revisions to pull.\n')
2137
else:
2138
to_file.write('Now on revision %d.\n' % self.new_revno)
2139
self._show_tag_conficts(to_file)
2140
2141
2142
class PushResult(_Result):
2143
"""Result of a Branch.push operation.
2144
2145
:ivar old_revno: Revision number before push.
2146
:ivar new_revno: Revision number after push.
2147
:ivar old_revid: Tip revision id before push.
2148
:ivar new_revid: Tip revision id after push.
2149
:ivar source_branch: Source branch object.
2150
:ivar master_branch: Master branch of the target, or None.
2151
:ivar target_branch: Target/destination branch object.
2152
"""
2153
2154
def __int__(self):
2155
# DEPRECATED: push used to return the change in revno
2156
return self.new_revno - self.old_revno
2157
2158
def report(self, to_file):
2159
"""Write a human-readable description of the result."""
2160
if self.old_revid == self.new_revid:
2161
to_file.write('No new revisions to push.\n')
2162
else:
2163
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2164
self._show_tag_conficts(to_file)
2165
2166
2167
class BranchCheckResult(object):
2168
"""Results of checking branch consistency.
2169
2170
:see: Branch.check
2171
"""
2172
2173
def __init__(self, branch):
2174
self.branch = branch
2175
2176
def report_results(self, verbose):
2177
"""Report the check results via trace.note.
2178
2179
:param verbose: Requests more detailed display of what was checked,
2180
if any.
2181
"""
2182
note('checked branch %s format %s',
2183
self.branch.base,
2184
self.branch._format)
2185
2186
2187
class Converter5to6(object):
2188
"""Perform an in-place upgrade of format 5 to format 6"""
2189
2190
def convert(self, branch):
2191
# Data for 5 and 6 can peacefully coexist.
2192
format = BzrBranchFormat6()
2193
new_branch = format.open(branch.bzrdir, _found=True)
2194
2195
# Copy source data into target
2196
new_branch.set_last_revision_info(*branch.last_revision_info())
2197
new_branch.set_parent(branch.get_parent())
2198
new_branch.set_bound_location(branch.get_bound_location())
2199
new_branch.set_push_location(branch.get_push_location())
2200
2201
# New branch has no tags by default
2202
new_branch.tags._set_tag_dict({})
2203
2204
# Copying done; now update target format
2205
new_branch.control_files.put_utf8('format',
2206
format.get_format_string())
2207
2208
# Clean up old files
2209
new_branch.control_files._transport.delete('revision-history')
2210
try:
2211
branch.set_parent(None)
2212
except NoSuchFile:
2213
pass
2214
branch.set_bound_location(None)
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0