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