« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 918
- compare with another revision
- download diff
- download tarball
- view history from revision 918
- Committer: Martin Pool
- Date: 2005-07-14 08:03:52 UTC
- Revision ID: mbp@sourcefrog.net-20050714080352-d8631baf3620057d
- start doing new weave-merge algorithm
- files added:
- bzrlib/changeset.py
- patches
- plugins/changeset
- files removed:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- 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/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- contrib/emacs
- tools/doc_generate
- files renamed:
- tools/doc_generate/autodoc_man.py => bzr-man.py
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/tests/ => bzrlib/selftest/
- bzrlib/tests/blackbox/test_too_much.py => bzrlib/selftest/blackbox.py
- bzrlib/tests/test_plugins.py => bzrlib/selftest/plugins.py
- bzrlib/tests/branch_implementations/test_branch.py => bzrlib/selftest/testbranch.py
- bzrlib/tests/test_hashcache.py => bzrlib/selftest/testhashcache.py
- bzrlib/tests/test_merge3.py => bzrlib/selftest/testmerge3.py
- bzrlib/tests/test_revisionnamespaces.py => bzrlib/selftest/testrevisionnamespaces.py
- bzrlib/tests/blackbox/test_status.py => bzrlib/selftest/teststatus.py
- bzrlib/tests/blackbox/test_versioning.py => bzrlib/selftest/versioning.py
- bzrlib/tests/test_whitebox.py => bzrlib/selftest/whitebox.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/xml_serializer.py => bzrlib/xml.py
- bzrlib/util/effbot/ => effbot/
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/plugins/ => plugins/
- bzrlib/tests/test_weave.py => tools/testweave.py
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
#
1
# Copyright (C) 2005 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
from copy import deepcopy
19
from cStringIO import StringIO
20
import errno
21
import os
22
import shutil
23
import sys
24
from unittest import TestSuite
25
from warnings import warn
18
import sys, os
26
19
27
20
import bzrlib
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
37
UnlistableStore,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
39
NoWorkingTree)
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
47
safe_unicode,
48
)
49
from bzrlib.textui import show_status
50
21
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
55
is_ancestor,
56
NULL_REVISION,
57
Revision,
58
)
59
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
64
import bzrlib.ui
65
import bzrlib.xml5
66
67
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
72
73
# TODO: Maybe include checks for common corruption of newlines, etc?
74
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
25
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
## TODO: Maybe include checks for common corruption of newlines, etc?
28
29
30
31
def find_branch(f, **args):
32
if f and (f.startswith('http://') or f.startswith('https://')):
33
import remotebranch
34
return remotebranch.RemoteBranch(f, **args)
35
else:
36
return Branch(f, **args)
37
38
39
def find_cached_branch(f, cache_root, **args):
40
from remotebranch import RemoteBranch
41
br = find_branch(f, **args)
42
def cacheify(br, store_name):
43
from meta_store import CachedStore
44
cache_path = os.path.join(cache_root, store_name)
45
os.mkdir(cache_path)
46
new_store = CachedStore(getattr(br, store_name), cache_path)
47
setattr(br, store_name, new_store)
48
49
if isinstance(br, RemoteBranch):
50
cacheify(br, 'inventory_store')
51
cacheify(br, 'text_store')
52
cacheify(br, 'revision_store')
53
return br
54
55
56
def _relpath(base, path):
57
"""Return path relative to base, or raise exception.
58
59
The path may be either an absolute path or a path relative to the
60
current working directory.
61
62
Lifted out of Branch.relpath for ease of testing.
63
64
os.path.commonprefix (python2.4) has a bad bug that it works just
65
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
66
avoids that problem."""
67
rp = os.path.abspath(path)
68
69
s = []
70
head = rp
71
while len(head) >= len(base):
72
if head == base:
73
break
74
head, tail = os.path.split(head)
75
if tail:
76
s.insert(0, tail)
77
else:
78
from errors import NotBranchError
79
raise NotBranchError("path %r is not within branch %r" % (rp, base))
80
81
return os.sep.join(s)
82
83
84
def find_branch_root(f=None):
85
"""Find the branch root enclosing f, or pwd.
86
87
f may be a filename or a URL.
88
89
It is not necessary that f exists.
90
91
Basically we keep looking up until we find the control directory or
92
run into the root."""
93
if f == None:
94
f = os.getcwd()
95
elif hasattr(os.path, 'realpath'):
96
f = os.path.realpath(f)
97
else:
98
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
101
102
103
orig_f = f
104
105
while True:
106
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
107
return f
108
head, tail = os.path.split(f)
109
if head == f:
110
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
112
f = head
113
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
Exception.__init__(self, "These branches have diverged.")
119
120
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
123
self.branch = branch
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
80
127
81
128
82
129
######################################################################
86
133
"""Branch holding a history of revisions.
87
134
88
135
base
89
Base directory/url of the branch.
136
Base directory of the branch.
137
138
_lock_mode
139
None, or 'r' or 'w'
140
141
_lock_count
142
If _lock_mode is true, a positive count of the number of times the
143
lock has been taken.
144
145
_lock
146
Lock object from bzrlib.lock.
90
147
"""
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
93
148
base = None
94
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
97
98
@staticmethod
99
@deprecated_method(zero_eight)
100
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
103
104
@staticmethod
105
def open(base, _unsupported=False):
106
"""Open the repository rooted at base.
107
108
For instance, if the repository is at URL/.bzr/repository,
109
Repository.open(URL) -> a Repository instance.
110
"""
111
control = bzrdir.BzrDir.open(base, _unsupported)
112
return control.open_branch(_unsupported)
113
114
@staticmethod
115
def open_containing(url):
116
"""Open an existing branch which contains url.
117
118
This probes for a branch at url, and searches upwards from there.
119
120
Basically we keep looking up until we find the control directory or
121
run into the root. If there isn't one, raises NotBranchError.
122
If there is one and it is either an unrecognised format or an unsupported
123
format, UnknownFormatError or UnsupportedFormatError are raised.
124
If there is one, it is returned, along with the unused portion of url.
125
"""
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
128
129
@staticmethod
130
@deprecated_function(zero_eight)
131
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
133
134
NOTE: This will soon be deprecated in favour of creation
135
through a BzrDir.
136
"""
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
138
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
142
"""
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
146
147
def _get_nick(self):
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
150
151
def _set_nick(self, nick):
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
155
156
nick = property(_get_nick, _set_nick)
157
149
_lock_mode = None
150
_lock_count = None
151
_lock = None
152
153
# Map some sort of prefix into a namespace
154
# stuff like "revno:10", "revid:", etc.
155
# This should match a prefix with a function which accepts
156
REVISION_NAMESPACES = {}
157
158
def __init__(self, base, init=False, find_root=True):
159
"""Create new branch object at a particular location.
160
161
base -- Base directory for the branch.
162
163
init -- If True, create new control files in a previously
164
unversioned directory. If False, the branch must already
165
be versioned.
166
167
find_root -- If true and init is false, find the root of the
168
existing branch containing base.
169
170
In the test suite, creation of new trees is tested using the
171
`ScratchBranch` class.
172
"""
173
from bzrlib.store import ImmutableStore
174
if init:
175
self.base = os.path.realpath(base)
176
self._make_control()
177
elif find_root:
178
self.base = find_branch_root(base)
179
else:
180
self.base = os.path.realpath(base)
181
if not isdir(self.controlfilename('.')):
182
from errors import NotBranchError
183
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
184
['use "bzr init" to initialize a new working tree',
185
'current bzr can only operate from top-of-tree'])
186
self._check_format()
187
188
self.text_store = ImmutableStore(self.controlfilename('text-store'))
189
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
190
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
191
192
193
def __str__(self):
194
return '%s(%r)' % (self.__class__.__name__, self.base)
195
196
197
__repr__ = __str__
198
199
200
def __del__(self):
201
if self._lock_mode or self._lock:
202
from warnings import warn
203
warn("branch %r was not explicitly unlocked" % self)
204
self._lock.unlock()
205
206
207
158
208
def lock_write(self):
159
raise NotImplementedError('lock_write is abstract')
160
209
if self._lock_mode:
210
if self._lock_mode != 'w':
211
from errors import LockError
212
raise LockError("can't upgrade to a write lock from %r" %
213
self._lock_mode)
214
self._lock_count += 1
215
else:
216
from bzrlib.lock import WriteLock
217
218
self._lock = WriteLock(self.controlfilename('branch-lock'))
219
self._lock_mode = 'w'
220
self._lock_count = 1
221
222
223
161
224
def lock_read(self):
162
raise NotImplementedError('lock_read is abstract')
163
225
if self._lock_mode:
226
assert self._lock_mode in ('r', 'w'), \
227
"invalid lock mode %r" % self._lock_mode
228
self._lock_count += 1
229
else:
230
from bzrlib.lock import ReadLock
231
232
self._lock = ReadLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'r'
234
self._lock_count = 1
235
236
237
164
238
def unlock(self):
165
raise NotImplementedError('unlock is abstract')
166
167
def peek_lock_mode(self):
168
"""Return lock mode for the Branch: 'r', 'w' or None"""
169
raise NotImplementedError(self.peek_lock_mode)
239
if not self._lock_mode:
240
from errors import LockError
241
raise LockError('branch %r is not locked' % (self))
242
243
if self._lock_count > 1:
244
self._lock_count -= 1
245
else:
246
self._lock.unlock()
247
self._lock = None
248
self._lock_mode = self._lock_count = None
249
170
250
171
251
def abspath(self, name):
172
"""Return absolute filename for something in the branch
173
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
176
"""
177
raise NotImplementedError('abspath is abstract')
178
179
def bind(self, other):
180
"""Bind the local branch the other branch.
181
182
:param other: The branch to bind to
183
:type other: Branch
184
"""
185
raise errors.UpgradeRequired(self.base)
186
187
@needs_write_lock
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
190
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
193
of the branch.
194
:param pb: An optional progress bar to use.
195
196
Returns the copied revision count and the failed revisions in a tuple:
197
(copied, failures).
198
"""
199
if self.base == from_branch.base:
200
raise Exception("can't fetch from a branch to itself %s, %s" %
201
(self.base, to_branch.base))
202
if pb is None:
203
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
204
pb = nested_pb
252
"""Return absolute filename for something in the branch"""
253
return os.path.join(self.base, name)
254
255
256
def relpath(self, path):
257
"""Return path relative to this branch of something inside it.
258
259
Raises an error if path is not in this branch."""
260
return _relpath(self.base, path)
261
262
263
def controlfilename(self, file_or_path):
264
"""Return location relative to branch."""
265
if isinstance(file_or_path, basestring):
266
file_or_path = [file_or_path]
267
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
268
269
270
def controlfile(self, file_or_path, mode='r'):
271
"""Open a control file for this branch.
272
273
There are two classes of file in the control directory: text
274
and binary. binary files are untranslated byte streams. Text
275
control files are stored with Unix newlines and in UTF-8, even
276
if the platform or locale defaults are different.
277
278
Controlfiles should almost never be opened in write mode but
279
rather should be atomically copied and replaced using atomicfile.
280
"""
281
282
fn = self.controlfilename(file_or_path)
283
284
if mode == 'rb' or mode == 'wb':
285
return file(fn, mode)
286
elif mode == 'r' or mode == 'w':
287
# open in binary mode anyhow so there's no newline translation;
288
# codecs uses line buffering by default; don't want that.
289
import codecs
290
return codecs.open(fn, mode + 'b', 'utf-8',
291
buffering=60000)
205
292
else:
206
nested_pb = None
207
208
from_branch.lock_read()
209
try:
210
if last_revision is None:
211
pb.update('get source history')
212
from_history = from_branch.revision_history()
213
if from_history:
214
last_revision = from_history[-1]
215
else:
216
# no history in the source branch
217
last_revision = NULL_REVISION
218
return self.repository.fetch(from_branch.repository,
219
revision_id=last_revision,
220
pb=nested_pb)
221
finally:
222
if nested_pb is not None:
223
nested_pb.finished()
224
from_branch.unlock()
225
226
def get_bound_location(self):
227
"""Return the URL of the rbanch we are bound to.
228
229
Older format branches cannot bind, please be sure to use a metadir
230
branch.
231
"""
232
return None
233
234
def get_master_branch(self):
235
"""Return the branch we are bound to.
293
raise BzrError("invalid controlfile mode %r" % mode)
294
295
296
297
def _make_control(self):
298
from bzrlib.inventory import Inventory
299
from bzrlib.xml import pack_xml
236
300
237
:return: Either a Branch, or None
301
os.mkdir(self.controlfilename([]))
302
self.controlfile('README', 'w').write(
303
"This is a Bazaar-NG control directory.\n"
304
"Do not change any files in this directory.\n")
305
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
306
for d in ('text-store', 'inventory-store', 'revision-store'):
307
os.mkdir(self.controlfilename(d))
308
for f in ('revision-history', 'merged-patches',
309
'pending-merged-patches', 'branch-name',
310
'branch-lock',
311
'pending-merges'):
312
self.controlfile(f, 'w').write('')
313
mutter('created control directory in ' + self.base)
314
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
316
317
318
def _check_format(self):
319
"""Check this branch format is supported.
320
321
The current tool only supports the current unstable format.
322
323
In the future, we might need different in-memory Branch
324
classes to support downlevel branches. But not yet.
238
325
"""
239
return None
326
# This ignores newlines so that we can open branches created
327
# on Windows from Linux and so on. I think it might be better
328
# to always make all internal files in unix format.
329
fmt = self.controlfile('branch-format', 'r').read()
330
fmt.replace('\r\n', '')
331
if fmt != BZR_BRANCH_FORMAT:
332
raise BzrError('sorry, branch format %r not supported' % fmt,
333
['use a different bzr version',
334
'or remove the .bzr directory and "bzr init" again'])
240
335
241
336
def get_root_id(self):
242
337
"""Return the id of this branches root"""
243
raise NotImplementedError('get_root_id is abstract')
244
245
def print_file(self, file, revision_id):
338
inv = self.read_working_inventory()
339
return inv.root.file_id
340
341
def set_root_id(self, file_id):
342
inv = self.read_working_inventory()
343
orig_root_id = inv.root.file_id
344
del inv._byid[inv.root.file_id]
345
inv.root.file_id = file_id
346
inv._byid[inv.root.file_id] = inv.root
347
for fid in inv:
348
entry = inv[fid]
349
if entry.parent_id in (None, orig_root_id):
350
entry.parent_id = inv.root.file_id
351
self._write_inventory(inv)
352
353
def read_working_inventory(self):
354
"""Read the working inventory."""
355
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
358
before = time()
359
self.lock_read()
360
try:
361
# ElementTree does its own conversion from UTF-8, so open in
362
# binary.
363
inv = unpack_xml(Inventory,
364
self.controlfile('inventory', 'rb'))
365
mutter("loaded inventory of %d items in %f"
366
% (len(inv), time() - before))
367
return inv
368
finally:
369
self.unlock()
370
371
372
def _write_inventory(self, inv):
373
"""Update the working inventory.
374
375
That is to say, the inventory describing changes underway, that
376
will be committed to the next revision.
377
"""
378
from bzrlib.atomicfile import AtomicFile
379
from bzrlib.xml import pack_xml
380
381
self.lock_write()
382
try:
383
f = AtomicFile(self.controlfilename('inventory'), 'wb')
384
try:
385
pack_xml(inv, f)
386
f.commit()
387
finally:
388
f.close()
389
finally:
390
self.unlock()
391
392
mutter('wrote working inventory')
393
394
395
inventory = property(read_working_inventory, _write_inventory, None,
396
"""Inventory for the working copy.""")
397
398
399
def add(self, files, verbose=False, ids=None):
400
"""Make files versioned.
401
402
Note that the command line normally calls smart_add instead.
403
404
This puts the files in the Added state, so that they will be
405
recorded by the next commit.
406
407
files
408
List of paths to add, relative to the base of the tree.
409
410
ids
411
If set, use these instead of automatically generated ids.
412
Must be the same length as the list of files, but may
413
contain None for ids that are to be autogenerated.
414
415
TODO: Perhaps have an option to add the ids even if the files do
416
not (yet) exist.
417
418
TODO: Perhaps return the ids of the files? But then again it
419
is easy to retrieve them if they're needed.
420
421
TODO: Adding a directory should optionally recurse down and
422
add all non-ignored children. Perhaps do that in a
423
higher-level method.
424
"""
425
from bzrlib.textui import show_status
426
# TODO: Re-adding a file that is removed in the working copy
427
# should probably put it back with the previous ID.
428
if isinstance(files, basestring):
429
assert(ids is None or isinstance(ids, basestring))
430
files = [files]
431
if ids is not None:
432
ids = [ids]
433
434
if ids is None:
435
ids = [None] * len(files)
436
else:
437
assert(len(ids) == len(files))
438
439
self.lock_write()
440
try:
441
inv = self.read_working_inventory()
442
for f,file_id in zip(files, ids):
443
if is_control_file(f):
444
raise BzrError("cannot add control file %s" % quotefn(f))
445
446
fp = splitpath(f)
447
448
if len(fp) == 0:
449
raise BzrError("cannot add top-level %r" % f)
450
451
fullpath = os.path.normpath(self.abspath(f))
452
453
try:
454
kind = file_kind(fullpath)
455
except OSError:
456
# maybe something better?
457
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
458
459
if kind != 'file' and kind != 'directory':
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if file_id is None:
463
file_id = gen_file_id(f)
464
inv.add_path(f, kind=kind, file_id=file_id)
465
466
if verbose:
467
print 'added', quotefn(f)
468
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
470
471
self._write_inventory(inv)
472
finally:
473
self.unlock()
474
475
476
def print_file(self, file, revno):
246
477
"""Print `file` to stdout."""
247
raise NotImplementedError('print_file is abstract')
478
self.lock_read()
479
try:
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
483
if not file_id:
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
486
finally:
487
self.unlock()
488
489
490
def remove(self, files, verbose=False):
491
"""Mark nominated files for removal from the inventory.
492
493
This does not remove their text. This does not run on
494
495
TODO: Refuse to remove modified files unless --force is given?
496
497
TODO: Do something useful with directories.
498
499
TODO: Should this remove the text or not? Tough call; not
500
removing may be useful and the user can just use use rm, and
501
is the opposite of add. Removing it is consistent with most
502
other tools. Maybe an option.
503
"""
504
from bzrlib.textui import show_status
505
## TODO: Normalize names
506
## TODO: Remove nested loops; better scalability
507
if isinstance(files, basestring):
508
files = [files]
509
510
self.lock_write()
511
512
try:
513
tree = self.working_tree()
514
inv = tree.inventory
515
516
# do this before any modifications
517
for f in files:
518
fid = inv.path2id(f)
519
if not fid:
520
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
521
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
522
if verbose:
523
# having remove it, it must be either ignored or unknown
524
if tree.is_ignored(f):
525
new_status = 'I'
526
else:
527
new_status = '?'
528
show_status(new_status, inv[fid].kind, quotefn(f))
529
del inv[fid]
530
531
self._write_inventory(inv)
532
finally:
533
self.unlock()
534
535
536
# FIXME: this doesn't need to be a branch method
537
def set_inventory(self, new_inventory_list):
538
from bzrlib.inventory import Inventory, InventoryEntry
539
inv = Inventory(self.get_root_id())
540
for path, file_id, parent, kind in new_inventory_list:
541
name = os.path.basename(path)
542
if name == "":
543
continue
544
inv.add(InventoryEntry(file_id, name, kind, parent))
545
self._write_inventory(inv)
546
547
548
def unknowns(self):
549
"""Return all unknown files.
550
551
These are files in the working directory that are not versioned or
552
control files or ignored.
553
554
>>> b = ScratchBranch(files=['foo', 'foo~'])
555
>>> list(b.unknowns())
556
['foo']
557
>>> b.add('foo')
558
>>> list(b.unknowns())
559
[]
560
>>> b.remove('foo')
561
>>> list(b.unknowns())
562
['foo']
563
"""
564
return self.working_tree().unknowns()
565
248
566
249
567
def append_revision(self, *revision_ids):
250
raise NotImplementedError('append_revision is abstract')
251
252
def set_revision_history(self, rev_history):
253
raise NotImplementedError('set_revision_history is abstract')
568
from bzrlib.atomicfile import AtomicFile
569
570
for revision_id in revision_ids:
571
mutter("add {%s} to revision-history" % revision_id)
572
573
rev_history = self.revision_history()
574
rev_history.extend(revision_ids)
575
576
f = AtomicFile(self.controlfilename('revision-history'))
577
try:
578
for rev_id in rev_history:
579
print >>f, rev_id
580
f.commit()
581
finally:
582
f.close()
583
584
585
def get_revision(self, revision_id):
586
"""Return the Revision object for a named revision"""
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
589
590
self.lock_read()
591
try:
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise ValueError('invalid revision-id: %r' % revision_id)
594
r = unpack_xml(Revision, self.revision_store[revision_id])
595
finally:
596
self.unlock()
597
598
assert r.revision_id == revision_id
599
return r
600
601
602
def get_revision_sha1(self, revision_id):
603
"""Hash the stored value of a revision, and return it."""
604
# In the future, revision entries will be signed. At that
605
# point, it is probably best *not* to include the signature
606
# in the revision hash. Because that lets you re-sign
607
# the revision, (add signatures/remove signatures) and still
608
# have all hash pointers stay consistent.
609
# But for now, just hash the contents.
610
return sha_file(self.revision_store[revision_id])
611
612
613
def get_inventory(self, inventory_id):
614
"""Get Inventory object by hash.
615
616
TODO: Perhaps for this and similar methods, take a revision
617
parameter which can be either an integer revno or a
618
string hash."""
619
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
621
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
623
624
625
def get_inventory_sha1(self, inventory_id):
626
"""Return the sha1 hash of the inventory entry
627
"""
628
return sha_file(self.inventory_store[inventory_id])
629
630
631
def get_revision_inventory(self, revision_id):
632
"""Return inventory of a past revision."""
633
# bzr 0.0.6 imposes the constraint that the inventory_id
634
# must be the same as its revision, so this is trivial.
635
if revision_id == None:
636
from bzrlib.inventory import Inventory
637
return Inventory(self.get_root_id())
638
else:
639
return self.get_inventory(revision_id)
640
254
641
255
642
def revision_history(self):
256
"""Return sequence of revision hashes on to this branch."""
257
raise NotImplementedError('revision_history is abstract')
643
"""Return sequence of revision hashes on to this branch.
644
645
>>> ScratchBranch().revision_history()
646
[]
647
"""
648
self.lock_read()
649
try:
650
return [l.rstrip('\r\n') for l in
651
self.controlfile('revision-history', 'r').readlines()]
652
finally:
653
self.unlock()
654
655
656
def common_ancestor(self, other, self_revno=None, other_revno=None):
657
"""
658
>>> import commit
659
>>> sb = ScratchBranch(files=['foo', 'foo~'])
660
>>> sb.common_ancestor(sb) == (None, None)
661
True
662
>>> commit.commit(sb, "Committing first revision", verbose=False)
663
>>> sb.common_ancestor(sb)[0]
664
1
665
>>> clone = sb.clone()
666
>>> commit.commit(sb, "Committing second revision", verbose=False)
667
>>> sb.common_ancestor(sb)[0]
668
2
669
>>> sb.common_ancestor(clone)[0]
670
1
671
>>> commit.commit(clone, "Committing divergent second revision",
672
... verbose=False)
673
>>> sb.common_ancestor(clone)[0]
674
1
675
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
676
True
677
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
678
True
679
>>> clone2 = sb.clone()
680
>>> sb.common_ancestor(clone2)[0]
681
2
682
>>> sb.common_ancestor(clone2, self_revno=1)[0]
683
1
684
>>> sb.common_ancestor(clone2, other_revno=1)[0]
685
1
686
"""
687
my_history = self.revision_history()
688
other_history = other.revision_history()
689
if self_revno is None:
690
self_revno = len(my_history)
691
if other_revno is None:
692
other_revno = len(other_history)
693
indices = range(min((self_revno, other_revno)))
694
indices.reverse()
695
for r in indices:
696
if my_history[r] == other_history[r]:
697
return r+1, my_history[r]
698
return None, None
699
700
def enum_history(self, direction):
701
"""Return (revno, revision_id) for history of branch.
702
703
direction
704
'forward' is from earliest to latest
705
'reverse' is from latest to earliest
706
"""
707
rh = self.revision_history()
708
if direction == 'forward':
709
i = 1
710
for rid in rh:
711
yield i, rid
712
i += 1
713
elif direction == 'reverse':
714
i = len(rh)
715
while i > 0:
716
yield i, rh[i-1]
717
i -= 1
718
else:
719
raise ValueError('invalid history direction', direction)
720
258
721
259
722
def revno(self):
260
723
"""Return current revision number for this branch.
264
727
"""
265
728
return len(self.revision_history())
266
729
267
def unbind(self):
268
"""Older format branches cannot bind or unbind."""
269
raise errors.UpgradeRequired(self.base)
270
730
271
def last_revision(self):
272
"""Return last patch hash, or None if no history."""
731
def last_patch(self):
732
"""Return last patch hash, or None if no history.
733
"""
273
734
ph = self.revision_history()
274
735
if ph:
275
736
return ph[-1]
276
737
else:
277
738
return None
278
739
740
279
741
def missing_revisions(self, other, stop_revision=None):
280
"""Return a list of new revisions that would perfectly fit.
281
742
"""
282
743
If self and other have not diverged, return a list of the revisions
283
744
present in other, but missing from self.
284
745
285
>>> from bzrlib.workingtree import WorkingTree
746
>>> from bzrlib.commit import commit
286
747
>>> bzrlib.trace.silent = True
287
>>> d1 = bzrdir.ScratchDir()
288
>>> br1 = d1.open_branch()
289
>>> wt1 = d1.open_workingtree()
290
>>> d2 = bzrdir.ScratchDir()
291
>>> br2 = d2.open_branch()
292
>>> wt2 = d2.open_workingtree()
748
>>> br1 = ScratchBranch()
749
>>> br2 = ScratchBranch()
293
750
>>> br1.missing_revisions(br2)
294
751
[]
295
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
752
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
296
753
>>> br1.missing_revisions(br2)
297
754
[u'REVISION-ID-1']
298
755
>>> br2.missing_revisions(br1)
299
756
[]
300
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
757
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
301
758
>>> br1.missing_revisions(br2)
302
759
[]
303
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
760
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
304
761
>>> br1.missing_revisions(br2)
305
762
[u'REVISION-ID-2A']
306
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
763
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
307
764
>>> br1.missing_revisions(br2)
308
765
Traceback (most recent call last):
309
DivergedBranches: These branches have diverged. Try merge.
766
DivergedBranches: These branches have diverged.
310
767
"""
311
768
self_history = self.revision_history()
312
769
self_len = len(self_history)
319
776
320
777
if stop_revision is None:
321
778
stop_revision = other_len
322
else:
323
assert isinstance(stop_revision, int)
324
if stop_revision > other_len:
325
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
779
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
781
326
782
return other_history[self_len:stop_revision]
327
783
784
328
785
def update_revisions(self, other, stop_revision=None):
329
"""Pull in new perfect-fit revisions.
330
331
:param other: Another Branch to pull from
332
:param stop_revision: Updated until the given revision
333
:return: None
334
"""
335
raise NotImplementedError('update_revisions is abstract')
336
337
def pullable_revisions(self, other, stop_revision):
338
raise NotImplementedError('pullable_revisions is abstract')
339
340
def revision_id_to_revno(self, revision_id):
341
"""Given a revision id, return its revno"""
342
if revision_id is None:
343
return 0
344
history = self.revision_history()
345
try:
346
return history.index(revision_id) + 1
347
except ValueError:
348
raise bzrlib.errors.NoSuchRevision(self, revision_id)
349
350
def get_rev_id(self, revno, history=None):
351
"""Find the revision id of the specified revno."""
352
if revno == 0:
353
return None
354
if history is None:
355
history = self.revision_history()
356
elif revno <= 0 or revno > len(history):
357
raise bzrlib.errors.NoSuchRevision(self, revno)
358
return history[revno - 1]
359
360
def pull(self, source, overwrite=False, stop_revision=None):
361
raise NotImplementedError('pull is abstract')
786
"""Pull in all new revisions from other branch.
787
788
>>> from bzrlib.commit import commit
789
>>> bzrlib.trace.silent = True
790
>>> br1 = ScratchBranch(files=['foo', 'bar'])
791
>>> br1.add('foo')
792
>>> br1.add('bar')
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
794
>>> br2 = ScratchBranch()
795
>>> br2.update_revisions(br1)
796
Added 2 texts.
797
Added 1 inventories.
798
Added 1 revisions.
799
>>> br2.revision_history()
800
[u'REVISION-ID-1']
801
>>> br2.update_revisions(br1)
802
Added 0 texts.
803
Added 0 inventories.
804
Added 0 revisions.
805
>>> br1.text_store.total_size() == br2.text_store.total_size()
806
True
807
"""
808
from bzrlib.progress import ProgressBar
809
try:
810
set
811
except NameError:
812
from sets import Set as set
813
814
pb = ProgressBar()
815
816
pb.update('comparing histories')
817
revision_ids = self.missing_revisions(other, stop_revision)
818
819
if hasattr(other.revision_store, "prefetch"):
820
other.revision_store.prefetch(revision_ids)
821
if hasattr(other.inventory_store, "prefetch"):
822
inventory_ids = [other.get_revision(r).inventory_id
823
for r in revision_ids]
824
other.inventory_store.prefetch(inventory_ids)
825
826
revisions = []
827
needed_texts = set()
828
i = 0
829
for rev_id in revision_ids:
830
i += 1
831
pb.update('fetching revision', i, len(revision_ids))
832
rev = other.get_revision(rev_id)
833
revisions.append(rev)
834
inv = other.get_inventory(str(rev.inventory_id))
835
for key, entry in inv.iter_entries():
836
if entry.text_id is None:
837
continue
838
if entry.text_id not in self.text_store:
839
needed_texts.add(entry.text_id)
840
841
pb.clear()
842
843
count = self.text_store.copy_multi(other.text_store, needed_texts)
844
print "Added %d texts." % count
845
inventory_ids = [ f.inventory_id for f in revisions ]
846
count = self.inventory_store.copy_multi(other.inventory_store,
847
inventory_ids)
848
print "Added %d inventories." % count
849
revision_ids = [ f.revision_id for f in revisions]
850
count = self.revision_store.copy_multi(other.revision_store,
851
revision_ids)
852
for revision_id in revision_ids:
853
self.append_revision(revision_id)
854
print "Added %d revisions." % count
855
856
857
def commit(self, *args, **kw):
858
from bzrlib.commit import commit
859
commit(self, *args, **kw)
860
861
862
def lookup_revision(self, revision):
863
"""Return the revision identifier for a given revision information."""
864
revno, info = self.get_revision_info(revision)
865
return info
866
867
def get_revision_info(self, revision):
868
"""Return (revno, revision id) for revision identifier.
869
870
revision can be an integer, in which case it is assumed to be revno (though
871
this will translate negative values into positive ones)
872
revision can also be a string, in which case it is parsed for something like
873
'date:' or 'revid:' etc.
874
"""
875
if revision is None:
876
return 0, None
877
revno = None
878
try:# Convert to int if possible
879
revision = int(revision)
880
except ValueError:
881
pass
882
revs = self.revision_history()
883
if isinstance(revision, int):
884
if revision == 0:
885
return 0, None
886
# Mabye we should do this first, but we don't need it if revision == 0
887
if revision < 0:
888
revno = len(revs) + revision + 1
889
else:
890
revno = revision
891
elif isinstance(revision, basestring):
892
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
893
if revision.startswith(prefix):
894
revno = func(self, revs, revision)
895
break
896
else:
897
raise BzrError('No namespace registered for string: %r' % revision)
898
899
if revno is None or revno <= 0 or revno > len(revs):
900
raise BzrError("no such revision %s" % revision)
901
return revno, revs[revno-1]
902
903
def _namespace_revno(self, revs, revision):
904
"""Lookup a revision by revision number"""
905
assert revision.startswith('revno:')
906
try:
907
return int(revision[6:])
908
except ValueError:
909
return None
910
REVISION_NAMESPACES['revno:'] = _namespace_revno
911
912
def _namespace_revid(self, revs, revision):
913
assert revision.startswith('revid:')
914
try:
915
return revs.index(revision[6:]) + 1
916
except ValueError:
917
return None
918
REVISION_NAMESPACES['revid:'] = _namespace_revid
919
920
def _namespace_last(self, revs, revision):
921
assert revision.startswith('last:')
922
try:
923
offset = int(revision[5:])
924
except ValueError:
925
return None
926
else:
927
if offset <= 0:
928
raise BzrError('You must supply a positive value for --revision last:XXX')
929
return len(revs) - offset + 1
930
REVISION_NAMESPACES['last:'] = _namespace_last
931
932
def _namespace_tag(self, revs, revision):
933
assert revision.startswith('tag:')
934
raise BzrError('tag: namespace registered, but not implemented.')
935
REVISION_NAMESPACES['tag:'] = _namespace_tag
936
937
def _namespace_date(self, revs, revision):
938
assert revision.startswith('date:')
939
import datetime
940
# Spec for date revisions:
941
# date:value
942
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
943
# it can also start with a '+/-/='. '+' says match the first
944
# entry after the given date. '-' is match the first entry before the date
945
# '=' is match the first entry after, but still on the given date.
946
#
947
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
948
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
949
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
950
# May 13th, 2005 at 0:00
951
#
952
# So the proper way of saying 'give me all entries for today' is:
953
# -r {date:+today}:{date:-tomorrow}
954
# The default is '=' when not supplied
955
val = revision[5:]
956
match_style = '='
957
if val[:1] in ('+', '-', '='):
958
match_style = val[:1]
959
val = val[1:]
960
961
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
962
if val.lower() == 'yesterday':
963
dt = today - datetime.timedelta(days=1)
964
elif val.lower() == 'today':
965
dt = today
966
elif val.lower() == 'tomorrow':
967
dt = today + datetime.timedelta(days=1)
968
else:
969
import re
970
# This should be done outside the function to avoid recompiling it.
971
_date_re = re.compile(
972
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
973
r'(,|T)?\s*'
974
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
975
)
976
m = _date_re.match(val)
977
if not m or (not m.group('date') and not m.group('time')):
978
raise BzrError('Invalid revision date %r' % revision)
979
980
if m.group('date'):
981
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
982
else:
983
year, month, day = today.year, today.month, today.day
984
if m.group('time'):
985
hour = int(m.group('hour'))
986
minute = int(m.group('minute'))
987
if m.group('second'):
988
second = int(m.group('second'))
989
else:
990
second = 0
991
else:
992
hour, minute, second = 0,0,0
993
994
dt = datetime.datetime(year=year, month=month, day=day,
995
hour=hour, minute=minute, second=second)
996
first = dt
997
last = None
998
reversed = False
999
if match_style == '-':
1000
reversed = True
1001
elif match_style == '=':
1002
last = dt + datetime.timedelta(days=1)
1003
1004
if reversed:
1005
for i in range(len(revs)-1, -1, -1):
1006
r = self.get_revision(revs[i])
1007
# TODO: Handle timezone.
1008
dt = datetime.datetime.fromtimestamp(r.timestamp)
1009
if first >= dt and (last is None or dt >= last):
1010
return i+1
1011
else:
1012
for i in range(len(revs)):
1013
r = self.get_revision(revs[i])
1014
# TODO: Handle timezone.
1015
dt = datetime.datetime.fromtimestamp(r.timestamp)
1016
if first <= dt and (last is None or dt <= last):
1017
return i+1
1018
REVISION_NAMESPACES['date:'] = _namespace_date
1019
1020
def revision_tree(self, revision_id):
1021
"""Return Tree for a revision on this branch.
1022
1023
`revision_id` may be None for the null revision, in which case
1024
an `EmptyTree` is returned."""
1025
from bzrlib.tree import EmptyTree, RevisionTree
1026
# TODO: refactor this to use an existing revision object
1027
# so we don't need to read it in twice.
1028
if revision_id == None:
1029
return EmptyTree(self.get_root_id())
1030
else:
1031
inv = self.get_revision_inventory(revision_id)
1032
return RevisionTree(self.text_store, inv)
1033
1034
1035
def working_tree(self):
1036
"""Return a `Tree` for the working copy."""
1037
from workingtree import WorkingTree
1038
return WorkingTree(self.base, self.read_working_inventory())
1039
362
1040
363
1041
def basis_tree(self):
364
1042
"""Return `Tree` object for last revision.
365
1043
366
1044
If there are no revisions yet, return an `EmptyTree`.
367
1045
"""
368
return self.repository.revision_tree(self.last_revision())
1046
from bzrlib.tree import EmptyTree, RevisionTree
1047
r = self.last_patch()
1048
if r == None:
1049
return EmptyTree(self.get_root_id())
1050
else:
1051
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1052
1053
369
1054
370
1055
def rename_one(self, from_rel, to_rel):
371
1056
"""Rename one file.
372
1057
373
1058
This can change the directory or the filename or both.
374
1059
"""
375
raise NotImplementedError('rename_one is abstract')
1060
self.lock_write()
1061
try:
1062
tree = self.working_tree()
1063
inv = tree.inventory
1064
if not tree.has_filename(from_rel):
1065
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1066
if tree.has_filename(to_rel):
1067
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1068
1069
file_id = inv.path2id(from_rel)
1070
if file_id == None:
1071
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1072
1073
if inv.path2id(to_rel):
1074
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1075
1076
to_dir, to_tail = os.path.split(to_rel)
1077
to_dir_id = inv.path2id(to_dir)
1078
if to_dir_id == None and to_dir != '':
1079
raise BzrError("can't determine destination directory id for %r" % to_dir)
1080
1081
mutter("rename_one:")
1082
mutter(" file_id {%s}" % file_id)
1083
mutter(" from_rel %r" % from_rel)
1084
mutter(" to_rel %r" % to_rel)
1085
mutter(" to_dir %r" % to_dir)
1086
mutter(" to_dir_id {%s}" % to_dir_id)
1087
1088
inv.rename(file_id, to_dir_id, to_tail)
1089
1090
print "%s => %s" % (from_rel, to_rel)
1091
1092
from_abs = self.abspath(from_rel)
1093
to_abs = self.abspath(to_rel)
1094
try:
1095
os.rename(from_abs, to_abs)
1096
except OSError, e:
1097
raise BzrError("failed to rename %r to %r: %s"
1098
% (from_abs, to_abs, e[1]),
1099
["rename rolled back"])
1100
1101
self._write_inventory(inv)
1102
finally:
1103
self.unlock()
1104
376
1105
377
1106
def move(self, from_paths, to_name):
378
1107
"""Rename files.
384
1113
385
1114
Note that to_name is only the last component of the new name;
386
1115
this doesn't change the directory.
387
388
This returns a list of (from_path, to_path) pairs for each
389
entry that is moved.
390
"""
391
raise NotImplementedError('move is abstract')
392
393
def get_parent(self):
394
"""Return the parent location of the branch.
395
396
This is the default location for push/pull/missing. The usual
397
pattern is that the user can override it by specifying a
398
location.
399
"""
400
raise NotImplementedError('get_parent is abstract')
401
402
def get_push_location(self):
403
"""Return the None or the location to push this branch to."""
404
raise NotImplementedError('get_push_location is abstract')
405
406
def set_push_location(self, location):
407
"""Set a new push location for this branch."""
408
raise NotImplementedError('set_push_location is abstract')
409
410
def set_parent(self, url):
411
raise NotImplementedError('set_parent is abstract')
412
413
@needs_write_lock
414
def update(self):
415
"""Synchronise this branch with the master branch if any.
416
417
:return: None or the last_revision pivoted out during the update.
418
"""
419
return None
420
421
def check_revno(self, revno):
422
"""\
423
Check whether a revno corresponds to any revision.
424
Zero (the NULL revision) is considered valid.
425
"""
426
if revno != 0:
427
self.check_real_revno(revno)
428
429
def check_real_revno(self, revno):
430
"""\
431
Check whether a revno corresponds to a real revision.
432
Zero (the NULL revision) is considered invalid
433
"""
434
if revno < 1 or revno > self.revno():
435
raise InvalidRevisionNumber(revno)
436
437
@needs_read_lock
438
def clone(self, *args, **kwargs):
439
"""Clone this branch into to_bzrdir preserving all semantic values.
440
441
revision_id: if not None, the revision history in the new branch will
442
be truncated to end with revision_id.
443
"""
444
# for API compatability, until 0.8 releases we provide the old api:
445
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
446
# after 0.8 releases, the *args and **kwargs should be changed:
447
# def clone(self, to_bzrdir, revision_id=None):
448
if (kwargs.get('to_location', None) or
449
kwargs.get('revision', None) or
450
kwargs.get('basis_branch', None) or
451
(len(args) and isinstance(args[0], basestring))):
452
# backwards compatability api:
453
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
454
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
455
# get basis_branch
456
if len(args) > 2:
457
basis_branch = args[2]
458
else:
459
basis_branch = kwargs.get('basis_branch', None)
460
if basis_branch:
461
basis = basis_branch.bzrdir
462
else:
463
basis = None
464
# get revision
465
if len(args) > 1:
466
revision_id = args[1]
467
else:
468
revision_id = kwargs.get('revision', None)
469
# get location
470
if len(args):
471
url = args[0]
472
else:
473
# no default to raise if not provided.
474
url = kwargs.get('to_location')
475
return self.bzrdir.clone(url,
476
revision_id=revision_id,
477
basis=basis).open_branch()
478
# new cleaner api.
479
# generate args by hand
480
if len(args) > 1:
481
revision_id = args[1]
482
else:
483
revision_id = kwargs.get('revision_id', None)
484
if len(args):
485
to_bzrdir = args[0]
486
else:
487
# no default to raise if not provided.
488
to_bzrdir = kwargs.get('to_bzrdir')
489
result = self._format.initialize(to_bzrdir)
490
self.copy_content_into(result, revision_id=revision_id)
491
return result
492
493
@needs_read_lock
494
def sprout(self, to_bzrdir, revision_id=None):
495
"""Create a new line of development from the branch, into to_bzrdir.
496
497
revision_id: if not None, the revision history in the new branch will
498
be truncated to end with revision_id.
499
"""
500
result = self._format.initialize(to_bzrdir)
501
self.copy_content_into(result, revision_id=revision_id)
502
result.set_parent(self.bzrdir.root_transport.base)
503
return result
504
505
@needs_read_lock
506
def copy_content_into(self, destination, revision_id=None):
507
"""Copy the content of self into destination.
508
509
revision_id: if not None, the revision history in the new branch will
510
be truncated to end with revision_id.
511
"""
512
new_history = self.revision_history()
513
if revision_id is not None:
514
try:
515
new_history = new_history[:new_history.index(revision_id) + 1]
516
except ValueError:
517
rev = self.repository.get_revision(revision_id)
518
new_history = rev.get_history(self.repository)[1:]
519
destination.set_revision_history(new_history)
520
parent = self.get_parent()
521
if parent:
522
destination.set_parent(parent)
523
524
525
class BranchFormat(object):
526
"""An encapsulation of the initialization and open routines for a format.
527
528
Formats provide three things:
529
* An initialization routine,
530
* a format string,
531
* an open routine.
532
533
Formats are placed in an dict by their format string for reference
534
during branch opening. Its not required that these be instances, they
535
can be classes themselves with class methods - it simply depends on
536
whether state is needed for a given format or not.
537
538
Once a format is deprecated, just deprecate the initialize and open
539
methods on the format class. Do not deprecate the object, as the
540
object will be created every time regardless.
541
"""
542
543
_default_format = None
544
"""The default format used for new branches."""
545
546
_formats = {}
547
"""The known formats."""
548
549
@classmethod
550
def find_format(klass, a_bzrdir):
551
"""Return the format for the branch object in a_bzrdir."""
552
try:
553
transport = a_bzrdir.get_branch_transport(None)
554
format_string = transport.get("format").read()
555
return klass._formats[format_string]
556
except NoSuchFile:
557
raise NotBranchError(path=transport.base)
558
except KeyError:
559
raise errors.UnknownFormatError(format_string)
560
561
@classmethod
562
def get_default_format(klass):
563
"""Return the current default format."""
564
return klass._default_format
565
566
def get_format_string(self):
567
"""Return the ASCII format string that identifies this format."""
568
raise NotImplementedError(self.get_format_string)
569
570
def initialize(self, a_bzrdir):
571
"""Create a branch of this format in a_bzrdir."""
572
raise NotImplementedError(self.initialized)
573
574
def is_supported(self):
575
"""Is this format supported?
576
577
Supported formats can be initialized and opened.
578
Unsupported formats may not support initialization or committing or
579
some other features depending on the reason for not being supported.
580
"""
581
return True
582
583
def open(self, a_bzrdir, _found=False):
584
"""Return the branch object for a_bzrdir
585
586
_found is a private parameter, do not use it. It is used to indicate
587
if format probing has already be done.
588
"""
589
raise NotImplementedError(self.open)
590
591
@classmethod
592
def register_format(klass, format):
593
klass._formats[format.get_format_string()] = format
594
595
@classmethod
596
def set_default_format(klass, format):
597
klass._default_format = format
598
599
@classmethod
600
def unregister_format(klass, format):
601
assert klass._formats[format.get_format_string()] is format
602
del klass._formats[format.get_format_string()]
603
604
def __str__(self):
605
return self.get_format_string().rstrip()
606
607
608
class BzrBranchFormat4(BranchFormat):
609
"""Bzr branch format 4.
610
611
This format has:
612
- a revision-history file.
613
- a branch-lock lock file [ to be shared with the bzrdir ]
614
"""
615
616
def initialize(self, a_bzrdir):
617
"""Create a branch of this format in a_bzrdir."""
618
mutter('creating branch in %s', a_bzrdir.transport.base)
619
branch_transport = a_bzrdir.get_branch_transport(self)
620
utf8_files = [('revision-history', ''),
621
('branch-name', ''),
622
]
623
control_files = LockableFiles(branch_transport, 'branch-lock',
624
TransportLock)
625
control_files.create_lock()
626
control_files.lock_write()
627
try:
628
for file, content in utf8_files:
629
control_files.put_utf8(file, content)
630
finally:
631
control_files.unlock()
632
return self.open(a_bzrdir, _found=True)
633
634
def __init__(self):
635
super(BzrBranchFormat4, self).__init__()
636
self._matchingbzrdir = bzrdir.BzrDirFormat6()
637
638
def open(self, a_bzrdir, _found=False):
639
"""Return the branch object for a_bzrdir
640
641
_found is a private parameter, do not use it. It is used to indicate
642
if format probing has already be done.
643
"""
644
if not _found:
645
# we are being called directly and must probe.
646
raise NotImplementedError
647
return BzrBranch(_format=self,
648
_control_files=a_bzrdir._control_files,
649
a_bzrdir=a_bzrdir,
650
_repository=a_bzrdir.open_repository())
651
652
def __str__(self):
653
return "Bazaar-NG branch format 4"
654
655
656
class BzrBranchFormat5(BranchFormat):
657
"""Bzr branch format 5.
658
659
This format has:
660
- a revision-history file.
661
- a format string
662
- a lock dir guarding the branch itself
663
- all of this stored in a branch/ subdirectory
664
- works with shared repositories.
665
666
This format is new in bzr 0.8.
667
"""
668
669
def get_format_string(self):
670
"""See BranchFormat.get_format_string()."""
671
return "Bazaar-NG branch format 5\n"
672
673
def initialize(self, a_bzrdir):
674
"""Create a branch of this format in a_bzrdir."""
675
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
676
branch_transport = a_bzrdir.get_branch_transport(self)
677
utf8_files = [('revision-history', ''),
678
('branch-name', ''),
679
]
680
control_files = LockableFiles(branch_transport, 'lock', LockDir)
681
control_files.create_lock()
682
control_files.lock_write()
683
control_files.put_utf8('format', self.get_format_string())
684
try:
685
for file, content in utf8_files:
686
control_files.put_utf8(file, content)
687
finally:
688
control_files.unlock()
689
return self.open(a_bzrdir, _found=True, )
690
691
def __init__(self):
692
super(BzrBranchFormat5, self).__init__()
693
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
694
695
def open(self, a_bzrdir, _found=False):
696
"""Return the branch object for a_bzrdir
697
698
_found is a private parameter, do not use it. It is used to indicate
699
if format probing has already be done.
700
"""
701
if not _found:
702
format = BranchFormat.find_format(a_bzrdir)
703
assert format.__class__ == self.__class__
704
transport = a_bzrdir.get_branch_transport(None)
705
control_files = LockableFiles(transport, 'lock', LockDir)
706
return BzrBranch5(_format=self,
707
_control_files=control_files,
708
a_bzrdir=a_bzrdir,
709
_repository=a_bzrdir.find_repository())
710
711
def __str__(self):
712
return "Bazaar-NG Metadir branch format 5"
713
714
715
class BranchReferenceFormat(BranchFormat):
716
"""Bzr branch reference format.
717
718
Branch references are used in implementing checkouts, they
719
act as an alias to the real branch which is at some other url.
720
721
This format has:
722
- A location file
723
- a format string
724
"""
725
726
def get_format_string(self):
727
"""See BranchFormat.get_format_string()."""
728
return "Bazaar-NG Branch Reference Format 1\n"
729
730
def initialize(self, a_bzrdir, target_branch=None):
731
"""Create a branch of this format in a_bzrdir."""
732
if target_branch is None:
733
# this format does not implement branch itself, thus the implicit
734
# creation contract must see it as uninitializable
735
raise errors.UninitializableFormat(self)
736
mutter('creating branch reference in %s', a_bzrdir.transport.base)
737
branch_transport = a_bzrdir.get_branch_transport(self)
738
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
739
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
740
branch_transport.put('format', StringIO(self.get_format_string()))
741
return self.open(a_bzrdir, _found=True)
742
743
def __init__(self):
744
super(BranchReferenceFormat, self).__init__()
745
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
746
747
def _make_reference_clone_function(format, a_branch):
748
"""Create a clone() routine for a branch dynamically."""
749
def clone(to_bzrdir, revision_id=None):
750
"""See Branch.clone()."""
751
return format.initialize(to_bzrdir, a_branch)
752
# cannot obey revision_id limits when cloning a reference ...
753
# FIXME RBC 20060210 either nuke revision_id for clone, or
754
# emit some sort of warning/error to the caller ?!
755
return clone
756
757
def open(self, a_bzrdir, _found=False):
758
"""Return the branch that the branch reference in a_bzrdir points at.
759
760
_found is a private parameter, do not use it. It is used to indicate
761
if format probing has already be done.
762
"""
763
if not _found:
764
format = BranchFormat.find_format(a_bzrdir)
765
assert format.__class__ == self.__class__
766
transport = a_bzrdir.get_branch_transport(None)
767
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
768
result = real_bzrdir.open_branch()
769
# this changes the behaviour of result.clone to create a new reference
770
# rather than a copy of the content of the branch.
771
# I did not use a proxy object because that needs much more extensive
772
# testing, and we are only changing one behaviour at the moment.
773
# If we decide to alter more behaviours - i.e. the implicit nickname
774
# then this should be refactored to introduce a tested proxy branch
775
# and a subclass of that for use in overriding clone() and ....
776
# - RBC 20060210
777
result.clone = self._make_reference_clone_function(result)
778
return result
779
780
781
# formats which have no format string are not discoverable
782
# and not independently creatable, so are not registered.
783
__default_format = BzrBranchFormat5()
784
BranchFormat.register_format(__default_format)
785
BranchFormat.register_format(BranchReferenceFormat())
786
BranchFormat.set_default_format(__default_format)
787
_legacy_formats = [BzrBranchFormat4(),
788
]
789
790
class BzrBranch(Branch):
791
"""A branch stored in the actual filesystem.
792
793
Note that it's "local" in the context of the filesystem; it doesn't
794
really matter if it's on an nfs/smb/afs/coda/... share, as long as
795
it's writable, and can be accessed via the normal filesystem API.
796
"""
797
798
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
799
relax_version_check=DEPRECATED_PARAMETER, _format=None,
800
_control_files=None, a_bzrdir=None, _repository=None):
801
"""Create new branch object at a particular location.
802
803
transport -- A Transport object, defining how to access files.
804
805
init -- If True, create new control files in a previously
806
unversioned directory. If False, the branch must already
807
be versioned.
808
809
relax_version_check -- If true, the usual check for the branch
810
version is not applied. This is intended only for
811
upgrade/recovery type use; it's not guaranteed that
812
all operations will work on old format branches.
813
"""
814
if a_bzrdir is None:
815
self.bzrdir = bzrdir.BzrDir.open(transport.base)
816
else:
817
self.bzrdir = a_bzrdir
818
self._transport = self.bzrdir.transport.clone('..')
819
self._base = self._transport.base
820
self._format = _format
821
if _control_files is None:
822
raise BzrBadParameterMissing('_control_files')
823
self.control_files = _control_files
824
if deprecated_passed(init):
825
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
826
"deprecated as of bzr 0.8. Please use Branch.create().",
827
DeprecationWarning,
828
stacklevel=2)
829
if init:
830
# this is slower than before deprecation, oh well never mind.
831
# -> its deprecated.
832
self._initialize(transport.base)
833
self._check_format(_format)
834
if deprecated_passed(relax_version_check):
835
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
836
"relax_version_check parameter is deprecated as of bzr 0.8. "
837
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
838
"open() method.",
839
DeprecationWarning,
840
stacklevel=2)
841
if (not relax_version_check
842
and not self._format.is_supported()):
843
raise errors.UnsupportedFormatError(
844
'sorry, branch format %r not supported' % fmt,
845
['use a different bzr version',
846
'or remove the .bzr directory'
847
' and "bzr init" again'])
848
if deprecated_passed(transport):
849
warn("BzrBranch.__init__(transport=XXX...): The transport "
850
"parameter is deprecated as of bzr 0.8. "
851
"Please use Branch.open, or bzrdir.open_branch().",
852
DeprecationWarning,
853
stacklevel=2)
854
self.repository = _repository
855
856
def __str__(self):
857
return '%s(%r)' % (self.__class__.__name__, self.base)
858
859
__repr__ = __str__
860
861
def __del__(self):
862
# TODO: It might be best to do this somewhere else,
863
# but it is nice for a Branch object to automatically
864
# cache it's information.
865
# Alternatively, we could have the Transport objects cache requests
866
# See the earlier discussion about how major objects (like Branch)
867
# should never expect their __del__ function to run.
868
# XXX: cache_root seems to be unused, 2006-01-13 mbp
869
if hasattr(self, 'cache_root') and self.cache_root is not None:
870
try:
871
shutil.rmtree(self.cache_root)
872
except:
873
pass
874
self.cache_root = None
875
876
def _get_base(self):
877
return self._base
878
879
base = property(_get_base, doc="The URL for the root of this branch.")
880
881
def _finish_transaction(self):
882
"""Exit the current transaction."""
883
return self.control_files._finish_transaction()
884
885
def get_transaction(self):
886
"""Return the current active transaction.
887
888
If no transaction is active, this returns a passthrough object
889
for which all data is immediately flushed and no caching happens.
890
"""
891
# this is an explicit function so that we can do tricky stuff
892
# when the storage in rev_storage is elsewhere.
893
# we probably need to hook the two 'lock a location' and
894
# 'have a transaction' together more delicately, so that
895
# we can have two locks (branch and storage) and one transaction
896
# ... and finishing the transaction unlocks both, but unlocking
897
# does not. - RBC 20051121
898
return self.control_files.get_transaction()
899
900
def _set_transaction(self, transaction):
901
"""Set a new active transaction."""
902
return self.control_files._set_transaction(transaction)
903
904
def abspath(self, name):
905
"""See Branch.abspath."""
906
return self.control_files._transport.abspath(name)
907
908
def _check_format(self, format):
909
"""Identify the branch format if needed.
910
911
The format is stored as a reference to the format object in
912
self._format for code that needs to check it later.
913
914
The format parameter is either None or the branch format class
915
used to open this branch.
916
917
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
918
"""
919
if format is None:
920
format = BzrBranchFormat.find_format(self.bzrdir)
921
self._format = format
922
mutter("got branch format %s", self._format)
923
924
@needs_read_lock
925
def get_root_id(self):
926
"""See Branch.get_root_id."""
927
tree = self.repository.revision_tree(self.last_revision())
928
return tree.inventory.root.file_id
929
930
def lock_write(self):
931
# TODO: test for failed two phase locks. This is known broken.
932
self.control_files.lock_write()
933
self.repository.lock_write()
934
935
def lock_read(self):
936
# TODO: test for failed two phase locks. This is known broken.
937
self.control_files.lock_read()
938
self.repository.lock_read()
939
940
def unlock(self):
941
# TODO: test for failed two phase locks. This is known broken.
942
self.repository.unlock()
943
self.control_files.unlock()
944
945
def peek_lock_mode(self):
946
if self.control_files._lock_count == 0:
947
return None
948
else:
949
return self.control_files._lock_mode
950
951
@needs_read_lock
952
def print_file(self, file, revision_id):
953
"""See Branch.print_file."""
954
return self.repository.print_file(file, revision_id)
955
956
@needs_write_lock
957
def append_revision(self, *revision_ids):
958
"""See Branch.append_revision."""
959
for revision_id in revision_ids:
960
mutter("add {%s} to revision-history" % revision_id)
961
rev_history = self.revision_history()
962
rev_history.extend(revision_ids)
963
self.set_revision_history(rev_history)
964
965
@needs_write_lock
966
def set_revision_history(self, rev_history):
967
"""See Branch.set_revision_history."""
968
self.control_files.put_utf8(
969
'revision-history', '\n'.join(rev_history))
970
transaction = self.get_transaction()
971
history = transaction.map.find_revision_history()
972
if history is not None:
973
# update the revision history in the identity map.
974
history[:] = list(rev_history)
975
# this call is disabled because revision_history is
976
# not really an object yet, and the transaction is for objects.
977
# transaction.register_dirty(history)
978
else:
979
transaction.map.add_revision_history(rev_history)
980
# this call is disabled because revision_history is
981
# not really an object yet, and the transaction is for objects.
982
# transaction.register_clean(history)
983
984
def get_revision_delta(self, revno):
985
"""Return the delta for one revision.
986
987
The delta is relative to its mainline predecessor, or the
988
empty tree for revision 1.
989
"""
990
assert isinstance(revno, int)
991
rh = self.revision_history()
992
if not (1 <= revno <= len(rh)):
993
raise InvalidRevisionNumber(revno)
994
995
# revno is 1-based; list is 0-based
996
997
new_tree = self.repository.revision_tree(rh[revno-1])
998
if revno == 1:
999
old_tree = EmptyTree()
1000
else:
1001
old_tree = self.repository.revision_tree(rh[revno-2])
1002
return compare_trees(old_tree, new_tree)
1003
1004
@needs_read_lock
1005
def revision_history(self):
1006
"""See Branch.revision_history."""
1007
transaction = self.get_transaction()
1008
history = transaction.map.find_revision_history()
1009
if history is not None:
1010
mutter("cache hit for revision-history in %s", self)
1011
return list(history)
1012
history = [l.rstrip('\r\n') for l in
1013
self.control_files.get_utf8('revision-history').readlines()]
1014
transaction.map.add_revision_history(history)
1015
# this call is disabled because revision_history is
1016
# not really an object yet, and the transaction is for objects.
1017
# transaction.register_clean(history, precious=True)
1018
return list(history)
1019
1020
def update_revisions(self, other, stop_revision=None):
1021
"""See Branch.update_revisions."""
1022
if stop_revision is None:
1023
stop_revision = other.last_revision()
1024
### Should this be checking is_ancestor instead of revision_history?
1025
if (stop_revision is not None and
1026
stop_revision in self.revision_history()):
1116
"""
1117
self.lock_write()
1118
try:
1119
## TODO: Option to move IDs only
1120
assert not isinstance(from_paths, basestring)
1121
tree = self.working_tree()
1122
inv = tree.inventory
1123
to_abs = self.abspath(to_name)
1124
if not isdir(to_abs):
1125
raise BzrError("destination %r is not a directory" % to_abs)
1126
if not tree.has_filename(to_name):
1127
raise BzrError("destination %r not in working directory" % to_abs)
1128
to_dir_id = inv.path2id(to_name)
1129
if to_dir_id == None and to_name != '':
1130
raise BzrError("destination %r is not a versioned directory" % to_name)
1131
to_dir_ie = inv[to_dir_id]
1132
if to_dir_ie.kind not in ('directory', 'root_directory'):
1133
raise BzrError("destination %r is not a directory" % to_abs)
1134
1135
to_idpath = inv.get_idpath(to_dir_id)
1136
1137
for f in from_paths:
1138
if not tree.has_filename(f):
1139
raise BzrError("%r does not exist in working tree" % f)
1140
f_id = inv.path2id(f)
1141
if f_id == None:
1142
raise BzrError("%r is not versioned" % f)
1143
name_tail = splitpath(f)[-1]
1144
dest_path = appendpath(to_name, name_tail)
1145
if tree.has_filename(dest_path):
1146
raise BzrError("destination %r already exists" % dest_path)
1147
if f_id in to_idpath:
1148
raise BzrError("can't move %r to a subdirectory of itself" % f)
1149
1150
# OK, so there's a race here, it's possible that someone will
1151
# create a file in this interval and then the rename might be
1152
# left half-done. But we should have caught most problems.
1153
1154
for f in from_paths:
1155
name_tail = splitpath(f)[-1]
1156
dest_path = appendpath(to_name, name_tail)
1157
print "%s => %s" % (f, dest_path)
1158
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1159
try:
1160
os.rename(self.abspath(f), self.abspath(dest_path))
1161
except OSError, e:
1162
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1163
["rename rolled back"])
1164
1165
self._write_inventory(inv)
1166
finally:
1167
self.unlock()
1168
1169
1170
def revert(self, filenames, old_tree=None, backups=True):
1171
"""Restore selected files to the versions from a previous tree.
1172
1173
backups
1174
If true (default) backups are made of files before
1175
they're renamed.
1176
"""
1177
from bzrlib.errors import NotVersionedError, BzrError
1178
from bzrlib.atomicfile import AtomicFile
1179
from bzrlib.osutils import backup_file
1180
1181
inv = self.read_working_inventory()
1182
if old_tree is None:
1183
old_tree = self.basis_tree()
1184
old_inv = old_tree.inventory
1185
1186
nids = []
1187
for fn in filenames:
1188
file_id = inv.path2id(fn)
1189
if not file_id:
1190
raise NotVersionedError("not a versioned file", fn)
1191
if not old_inv.has_id(file_id):
1192
raise BzrError("file not present in old tree", fn, file_id)
1193
nids.append((fn, file_id))
1194
1195
# TODO: Rename back if it was previously at a different location
1196
1197
# TODO: If given a directory, restore the entire contents from
1198
# the previous version.
1199
1200
# TODO: Make a backup to a temporary file.
1201
1202
# TODO: If the file previously didn't exist, delete it?
1203
for fn, file_id in nids:
1204
backup_file(fn)
1205
1206
f = AtomicFile(fn, 'wb')
1207
try:
1208
f.write(old_tree.get_file(file_id).read())
1209
f.commit()
1210
finally:
1211
f.close()
1212
1213
1214
def pending_merges(self):
1215
"""Return a list of pending merges.
1216
1217
These are revisions that have been merged into the working
1218
directory but not yet committed.
1219
"""
1220
cfn = self.controlfilename('pending-merges')
1221
if not os.path.exists(cfn):
1222
return []
1223
p = []
1224
for l in self.controlfile('pending-merges', 'r').readlines():
1225
p.append(l.rstrip('\n'))
1226
return p
1227
1228
1229
def add_pending_merge(self, revision_id):
1230
from bzrlib.revision import validate_revision_id
1231
1232
validate_revision_id(revision_id)
1233
1234
p = self.pending_merges()
1235
if revision_id in p:
1027
1236
return
1028
self.fetch(other, stop_revision)
1029
pullable_revs = self.pullable_revisions(other, stop_revision)
1030
if len(pullable_revs) > 0:
1031
self.append_revision(*pullable_revs)
1032
1033
def pullable_revisions(self, other, stop_revision):
1034
other_revno = other.revision_id_to_revno(stop_revision)
1035
try:
1036
return self.missing_revisions(other, other_revno)
1037
except DivergedBranches, e:
1038
try:
1039
pullable_revs = get_intervening_revisions(self.last_revision(),
1040
stop_revision,
1041
self.repository)
1042
assert self.last_revision() not in pullable_revs
1043
return pullable_revs
1044
except bzrlib.errors.NotAncestor:
1045
if is_ancestor(self.last_revision(), stop_revision, self):
1046
return []
1047
else:
1048
raise e
1049
1050
def basis_tree(self):
1051
"""See Branch.basis_tree."""
1052
return self.repository.revision_tree(self.last_revision())
1053
1054
@deprecated_method(zero_eight)
1055
def working_tree(self):
1056
"""Create a Working tree object for this branch."""
1057
from bzrlib.workingtree import WorkingTree
1058
from bzrlib.transport.local import LocalTransport
1059
if (self.base.find('://') != -1 or
1060
not isinstance(self._transport, LocalTransport)):
1061
raise NoWorkingTree(self.base)
1062
return self.bzrdir.open_workingtree()
1063
1064
@needs_write_lock
1065
def pull(self, source, overwrite=False, stop_revision=None):
1066
"""See Branch.pull."""
1067
source.lock_read()
1068
try:
1069
old_count = len(self.revision_history())
1070
try:
1071
self.update_revisions(source,stop_revision)
1072
except DivergedBranches:
1073
if not overwrite:
1074
raise
1075
if overwrite:
1076
self.set_revision_history(source.revision_history())
1077
new_count = len(self.revision_history())
1078
return new_count - old_count
1237
p.append(revision_id)
1238
self.set_pending_merges(p)
1239
1240
1241
def set_pending_merges(self, rev_list):
1242
from bzrlib.atomicfile import AtomicFile
1243
self.lock_write()
1244
try:
1245
f = AtomicFile(self.controlfilename('pending-merges'))
1246
try:
1247
for l in rev_list:
1248
print >>f, l
1249
f.commit()
1250
finally:
1251
f.close()
1079
1252
finally:
1080
source.unlock()
1081
1082
def get_parent(self):
1083
"""See Branch.get_parent."""
1084
import errno
1085
_locs = ['parent', 'pull', 'x-pull']
1086
for l in _locs:
1087
try:
1088
return self.control_files.get_utf8(l).read().strip('\n')
1089
except NoSuchFile:
1090
pass
1091
return None
1092
1093
def get_push_location(self):
1094
"""See Branch.get_push_location."""
1095
config = bzrlib.config.BranchConfig(self)
1096
push_loc = config.get_user_option('push_location')
1097
return push_loc
1098
1099
def set_push_location(self, location):
1100
"""See Branch.set_push_location."""
1101
config = bzrlib.config.LocationConfig(self.base)
1102
config.set_user_option('push_location', location)
1103
1104
@needs_write_lock
1105
def set_parent(self, url):
1106
"""See Branch.set_parent."""
1107
# TODO: Maybe delete old location files?
1108
# URLs should never be unicode, even on the local fs,
1109
# FIXUP this and get_parent in a future branch format bump:
1110
# read and rewrite the file, and have the new format code read
1111
# using .get not .get_utf8. RBC 20060125
1112
self.control_files.put_utf8('parent', url + '\n')
1113
1114
def tree_config(self):
1115
return TreeConfig(self)
1116
1117
1118
class BzrBranch5(BzrBranch):
1119
"""A format 5 branch. This supports new features over plan branches.
1120
1121
It has support for a master_branch which is the data for bound branches.
1253
self.unlock()
1254
1255
1256
1257
class ScratchBranch(Branch):
1258
"""Special test class: a branch that cleans up after itself.
1259
1260
>>> b = ScratchBranch()
1261
>>> isdir(b.base)
1262
True
1263
>>> bd = b.base
1264
>>> b.destroy()
1265
>>> isdir(bd)
1266
False
1122
1267
"""
1123
1124
def __init__(self,
1125
_format,
1126
_control_files,
1127
a_bzrdir,
1128
_repository):
1129
super(BzrBranch5, self).__init__(_format=_format,
1130
_control_files=_control_files,
1131
a_bzrdir=a_bzrdir,
1132
_repository=_repository)
1133
1134
@needs_write_lock
1135
def pull(self, source, overwrite=False, stop_revision=None):
1136
"""Updates branch.pull to be bound branch aware."""
1137
bound_location = self.get_bound_location()
1138
if source.base != bound_location:
1139
# not pulling from master, so we need to update master.
1140
master_branch = self.get_master_branch()
1141
if master_branch:
1142
master_branch.pull(source)
1143
source = master_branch
1144
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1145
1146
def get_bound_location(self):
1147
try:
1148
return self.control_files.get_utf8('bound').read()[:-1]
1149
except errors.NoSuchFile:
1150
return None
1151
1152
@needs_read_lock
1153
def get_master_branch(self):
1154
"""Return the branch we are bound to.
1155
1156
:return: Either a Branch, or None
1157
1158
This could memoise the branch, but if thats done
1159
it must be revalidated on each new lock.
1160
So for now we just dont memoise it.
1161
# RBC 20060304 review this decision.
1162
"""
1163
bound_loc = self.get_bound_location()
1164
if not bound_loc:
1165
return None
1166
try:
1167
return Branch.open(bound_loc)
1168
except (errors.NotBranchError, errors.ConnectionError), e:
1169
raise errors.BoundBranchConnectionFailure(
1170
self, bound_loc, e)
1171
1172
@needs_write_lock
1173
def set_bound_location(self, location):
1174
"""Set the target where this branch is bound to.
1175
1176
:param location: URL to the target branch
1177
"""
1178
if location:
1179
self.control_files.put_utf8('bound', location+'\n')
1180
else:
1181
try:
1182
self.control_files._transport.delete('bound')
1183
except NoSuchFile:
1184
return False
1268
def __init__(self, files=[], dirs=[], base=None):
1269
"""Make a test branch.
1270
1271
This creates a temporary directory and runs init-tree in it.
1272
1273
If any files are listed, they are created in the working copy.
1274
"""
1275
from tempfile import mkdtemp
1276
init = False
1277
if base is None:
1278
base = mkdtemp()
1279
init = True
1280
Branch.__init__(self, base, init=init)
1281
for d in dirs:
1282
os.mkdir(self.abspath(d))
1283
1284
for f in files:
1285
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1286
1287
1288
def clone(self):
1289
"""
1290
>>> orig = ScratchBranch(files=["file1", "file2"])
1291
>>> clone = orig.clone()
1292
>>> os.path.samefile(orig.base, clone.base)
1293
False
1294
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1295
True
1296
"""
1297
from shutil import copytree
1298
from tempfile import mkdtemp
1299
base = mkdtemp()
1300
os.rmdir(base)
1301
copytree(self.base, base, symlinks=True)
1302
return ScratchBranch(base=base)
1303
1304
def __del__(self):
1305
self.destroy()
1306
1307
def destroy(self):
1308
"""Destroy the test branch, removing the scratch directory."""
1309
from shutil import rmtree
1310
try:
1311
if self.base:
1312
mutter("delete ScratchBranch %s" % self.base)
1313
rmtree(self.base)
1314
except OSError, e:
1315
# Work around for shutil.rmtree failing on Windows when
1316
# readonly files are encountered
1317
mutter("hit exception in destroying ScratchBranch: %s" % e)
1318
for root, dirs, files in os.walk(self.base, topdown=False):
1319
for name in files:
1320
os.chmod(os.path.join(root, name), 0700)
1321
rmtree(self.base)
1322
self.base = None
1323
1324
1325
1326
######################################################################
1327
# predicates
1328
1329
1330
def is_control_file(filename):
1331
## FIXME: better check
1332
filename = os.path.normpath(filename)
1333
while filename != '':
1334
head, tail = os.path.split(filename)
1335
## mutter('check %r for control file' % ((head, tail), ))
1336
if tail == bzrlib.BZRDIR:
1185
1337
return True
1186
1187
@needs_write_lock
1188
def bind(self, other):
1189
"""Bind the local branch the other branch.
1190
1191
:param other: The branch to bind to
1192
:type other: Branch
1193
"""
1194
# TODO: jam 20051230 Consider checking if the target is bound
1195
# It is debatable whether you should be able to bind to
1196
# a branch which is itself bound.
1197
# Committing is obviously forbidden,
1198
# but binding itself may not be.
1199
# Since we *have* to check at commit time, we don't
1200
# *need* to check here
1201
self.pull(other)
1202
1203
# we are now equal to or a suffix of other.
1204
1205
# Since we have 'pulled' from the remote location,
1206
# now we should try to pull in the opposite direction
1207
# in case the local tree has more revisions than the
1208
# remote one.
1209
# There may be a different check you could do here
1210
# rather than actually trying to install revisions remotely.
1211
# TODO: capture an exception which indicates the remote branch
1212
# is not writeable.
1213
# If it is up-to-date, this probably should not be a failure
1214
1215
# lock other for write so the revision-history syncing cannot race
1216
other.lock_write()
1217
try:
1218
other.pull(self)
1219
# if this does not error, other now has the same last rev we do
1220
# it can only error if the pull from other was concurrent with
1221
# a commit to other from someone else.
1222
1223
# until we ditch revision-history, we need to sync them up:
1224
self.set_revision_history(other.revision_history())
1225
# now other and self are up to date with each other and have the
1226
# same revision-history.
1227
finally:
1228
other.unlock()
1229
1230
self.set_bound_location(other.base)
1231
1232
@needs_write_lock
1233
def unbind(self):
1234
"""If bound, unbind"""
1235
return self.set_bound_location(None)
1236
1237
@needs_write_lock
1238
def update(self):
1239
"""Synchronise this branch with the master branch if any.
1240
1241
:return: None or the last_revision that was pivoted out during the
1242
update.
1243
"""
1244
master = self.get_master_branch()
1245
if master is not None:
1246
old_tip = self.last_revision()
1247
self.pull(master, overwrite=True)
1248
if old_tip in self.repository.get_ancestry(self.last_revision()):
1249
return None
1250
return old_tip
1251
return None
1252
1253
1254
class BranchTestProviderAdapter(object):
1255
"""A tool to generate a suite testing multiple branch formats at once.
1256
1257
This is done by copying the test once for each transport and injecting
1258
the transport_server, transport_readonly_server, and branch_format
1259
classes into each copy. Each copy is also given a new id() to make it
1260
easy to identify.
1261
"""
1262
1263
def __init__(self, transport_server, transport_readonly_server, formats):
1264
self._transport_server = transport_server
1265
self._transport_readonly_server = transport_readonly_server
1266
self._formats = formats
1267
1268
def adapt(self, test):
1269
result = TestSuite()
1270
for branch_format, bzrdir_format in self._formats:
1271
new_test = deepcopy(test)
1272
new_test.transport_server = self._transport_server
1273
new_test.transport_readonly_server = self._transport_readonly_server
1274
new_test.bzrdir_format = bzrdir_format
1275
new_test.branch_format = branch_format
1276
def make_new_test_id():
1277
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1278
return lambda: new_id
1279
new_test.id = make_new_test_id()
1280
result.addTest(new_test)
1281
return result
1282
1283
1284
######################################################################
1285
# predicates
1286
1287
1288
@deprecated_function(zero_eight)
1289
def ScratchBranch(*args, **kwargs):
1290
"""See bzrlib.bzrdir.ScratchDir."""
1291
d = ScratchDir(*args, **kwargs)
1292
return d.open_branch()
1293
1294
1295
@deprecated_function(zero_eight)
1296
def is_control_file(*args, **kwargs):
1297
"""See bzrlib.workingtree.is_control_file."""
1298
return bzrlib.workingtree.is_control_file(*args, **kwargs)
1338
if filename == head:
1339
break
1340
filename = head
1341
return False
1342
1343
1344
1345
def gen_file_id(name):
1346
"""Return new file id.
1347
1348
This should probably generate proper UUIDs, but for the moment we
1349
cope with just randomness because running uuidgen every time is
1350
slow."""
1351
import re
1352
from binascii import hexlify
1353
from time import time
1354
1355
# get last component
1356
idx = name.rfind('/')
1357
if idx != -1:
1358
name = name[idx+1 : ]
1359
idx = name.rfind('\\')
1360
if idx != -1:
1361
name = name[idx+1 : ]
1362
1363
# make it not a hidden file
1364
name = name.lstrip('.')
1365
1366
# remove any wierd characters; we don't escape them but rather
1367
# just pull them out
1368
name = re.sub(r'[^\w.]', '', name)
1369
1370
s = hexlify(rand_bytes(8))
1371
return '-'.join((name, compact_date(time()), s))
1372
1373
1374
def gen_root_id():
1375
"""Return a new tree-root file id."""
1376
return gen_file_id('TREE_ROOT')
1377
Loggerhead is a web-based interface for Breezy
Version: 2.0.1