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