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