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