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 1773.4.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1773.4.1
- Committer: Martin Pool
- Date: 2006-06-20 03:57:11 UTC
- mto: This revision was merged to the branch mainline in revision 1798.
- Revision ID: mbp@sourcefrog.net-20060620035711-400bb6b6bc6ff95b
Add pyflakes makefile target; fix many warnings
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- 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/test_patches_data
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- tools/doc_generate
- files removed:
- bzrlib/mdiff.py
- notes
- patches
- plugins/changeset
- 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/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- tutorial.txt => doc/tutorial.txt
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006 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 copy import deepcopy
19
from cStringIO import StringIO
20
from unittest import TestSuite
21
from warnings import warn
20
22
21
23
import bzrlib
24
import bzrlib.bzrdir as bzrdir
25
from bzrlib.config import TreeConfig
26
from bzrlib.decorators import needs_read_lock, needs_write_lock
27
from bzrlib.delta import compare_trees
28
import bzrlib.errors as errors
29
from bzrlib.errors import (InvalidRevisionNumber,
30
NotBranchError,
31
DivergedBranches,
32
NoSuchFile,
33
NoWorkingTree)
34
from bzrlib.lockable_files import LockableFiles, TransportLock
35
from bzrlib.lockdir import LockDir
36
from bzrlib.osutils import (
37
rmtree,
38
)
39
from bzrlib.revision import (
40
NULL_REVISION,
41
)
42
from bzrlib.symbol_versioning import (deprecated_function,
43
deprecated_method,
44
DEPRECATED_PARAMETER,
45
deprecated_passed,
46
zero_eight,
47
)
22
48
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
49
from bzrlib.tree import EmptyTree
50
import bzrlib.ui as ui
51
import bzrlib.urlutils as urlutils
52
53
54
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
55
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
56
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
57
58
59
# TODO: Maybe include checks for common corruption of newlines, etc?
37
60
38
61
# TODO: Some operations like log might retrieve the same revisions
39
62
# 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.")
63
# cache in memory to make this faster. In general anything can be
64
# cached in memory between lock and unlock operations. .. nb thats
65
# what the transaction identity map provides
131
66
132
67
133
68
######################################################################
137
72
"""Branch holding a history of revisions.
138
73
139
74
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.
75
Base directory/url of the branch.
151
76
"""
77
# this is really an instance variable - FIXME move it there
78
# - RBC 20060112
152
79
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
80
81
def __init__(self, *ignored, **ignored_too):
82
raise NotImplementedError('The Branch class is abstract')
83
84
def break_lock(self):
85
"""Break a lock if one is present from another instance.
86
87
Uses the ui factory to ask for confirmation if the lock may be from
88
an active process.
89
90
This will probe the repository for its lock as well.
91
"""
92
self.control_files.break_lock()
93
self.repository.break_lock()
94
master = self.get_master_branch()
95
if master is not None:
96
master.break_lock()
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
158
def is_locked(self):
159
raise NotImplementedError('is_locked is abstract')
211
160
212
161
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
162
raise NotImplementedError('lock_write is abstract')
227
163
228
164
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
165
raise NotImplementedError('lock_read is abstract')
166
242
167
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
168
raise NotImplementedError('unlock is abstract')
169
170
def peek_lock_mode(self):
171
"""Return lock mode for the Branch: 'r', 'w' or None"""
172
raise NotImplementedError(self.peek_lock_mode)
173
174
def get_physical_lock_status(self):
175
raise NotImplementedError('get_physical_lock_status is abstract')
254
176
255
177
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)
178
"""Return absolute filename for something in the branch
179
180
XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
method and not a tree method.
182
"""
183
raise NotImplementedError('abspath is abstract')
184
185
def bind(self, other):
186
"""Bind the local branch the other branch.
187
188
:param other: The branch to bind to
189
:type other: Branch
190
"""
191
raise errors.UpgradeRequired(self.base)
192
193
@needs_write_lock
194
def fetch(self, from_branch, last_revision=None, pb=None):
195
"""Copy revisions from from_branch into this branch.
196
197
:param from_branch: Where to copy from.
198
:param last_revision: What revision to stop at (None for at the end
199
of the branch.
200
:param pb: An optional progress bar to use.
201
202
Returns the copied revision count and the failed revisions in a tuple:
203
(copied, failures).
204
"""
205
if self.base == from_branch.base:
206
return (0, [])
207
if pb is None:
208
nested_pb = ui.ui_factory.nested_progress_bar()
209
pb = nested_pb
296
210
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'])
211
nested_pb = None
212
213
from_branch.lock_read()
214
try:
215
if last_revision is None:
216
pb.update('get source history')
217
from_history = from_branch.revision_history()
218
if from_history:
219
last_revision = from_history[-1]
220
else:
221
# no history in the source branch
222
last_revision = NULL_REVISION
223
return self.repository.fetch(from_branch.repository,
224
revision_id=last_revision,
225
pb=nested_pb)
226
finally:
227
if nested_pb is not None:
228
nested_pb.finished()
229
from_branch.unlock()
230
231
def get_bound_location(self):
232
"""Return the URL of the branch we are bound to.
233
234
Older format branches cannot bind, please be sure to use a metadir
235
branch.
236
"""
237
return None
238
239
def get_commit_builder(self, parents, config=None, timestamp=None,
240
timezone=None, committer=None, revprops=None,
241
revision_id=None):
242
"""Obtain a CommitBuilder for this branch.
243
244
:param parents: Revision ids of the parents of the new revision.
245
:param config: Optional configuration to use.
246
:param timestamp: Optional timestamp recorded for commit.
247
:param timezone: Optional timezone for timestamp.
248
:param committer: Optional committer to set for commit.
249
:param revprops: Optional dictionary of revision properties.
250
:param revision_id: Optional revision id.
251
"""
252
253
if config is None:
254
config = bzrlib.config.BranchConfig(self)
255
256
return self.repository.get_commit_builder(self, parents, config,
257
timestamp, timezone, committer, revprops, revision_id)
258
259
def get_master_branch(self):
260
"""Return the branch we are bound to.
261
262
:return: Either a Branch, or None
263
"""
264
return None
339
265
340
266
def get_root_id(self):
341
267
"""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):
268
raise NotImplementedError('get_root_id is abstract')
269
270
def print_file(self, file, revision_id):
480
271
"""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
272
raise NotImplementedError('print_file is abstract')
568
273
569
274
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
616
617
def get_revision_delta(self, revno):
618
"""Return the delta for one revision.
619
620
The delta is relative to its mainline predecessor, or the
621
empty tree for revision 1.
622
"""
623
assert isinstance(revno, int)
624
rh = self.revision_history()
625
if not (1 <= revno <= len(rh)):
626
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
275
raise NotImplementedError('append_revision is abstract')
276
277
def set_revision_history(self, rev_history):
278
raise NotImplementedError('set_revision_history is abstract')
679
279
680
280
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
281
"""Return sequence of revision hashes on to this branch."""
282
raise NotImplementedError('revision_history is abstract')
738
283
739
284
def revno(self):
740
285
"""Return current revision number for this branch.
744
289
"""
745
290
return len(self.revision_history())
746
291
292
def unbind(self):
293
"""Older format branches cannot bind or unbind."""
294
raise errors.UpgradeRequired(self.base)
747
295
748
def last_patch(self):
749
"""Return last patch hash, or None if no history.
750
"""
296
def last_revision(self):
297
"""Return last patch hash, or None if no history."""
751
298
ph = self.revision_history()
752
299
if ph:
753
300
return ph[-1]
754
301
else:
755
302
return None
756
303
757
758
304
def missing_revisions(self, other, stop_revision=None):
759
"""
305
"""Return a list of new revisions that would perfectly fit.
306
760
307
If self and other have not diverged, return a list of the revisions
761
308
present in other, but missing from self.
762
309
763
>>> from bzrlib.commit import commit
310
>>> from bzrlib.workingtree import WorkingTree
764
311
>>> bzrlib.trace.silent = True
765
>>> br1 = ScratchBranch()
766
>>> br2 = ScratchBranch()
312
>>> d1 = bzrdir.ScratchDir()
313
>>> br1 = d1.open_branch()
314
>>> wt1 = d1.open_workingtree()
315
>>> d2 = bzrdir.ScratchDir()
316
>>> br2 = d2.open_branch()
317
>>> wt2 = d2.open_workingtree()
767
318
>>> br1.missing_revisions(br2)
768
319
[]
769
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
320
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
770
321
>>> br1.missing_revisions(br2)
771
322
[u'REVISION-ID-1']
772
323
>>> br2.missing_revisions(br1)
773
324
[]
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
325
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
775
326
>>> br1.missing_revisions(br2)
776
327
[]
777
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
328
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
778
329
>>> br1.missing_revisions(br2)
779
330
[u'REVISION-ID-2A']
780
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
331
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
781
332
>>> br1.missing_revisions(br2)
782
333
Traceback (most recent call last):
783
DivergedBranches: These branches have diverged.
334
DivergedBranches: These branches have diverged. Try merge.
784
335
"""
785
336
self_history = self.revision_history()
786
337
self_len = len(self_history)
793
344
794
345
if stop_revision is None:
795
346
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
798
347
else:
348
assert isinstance(stop_revision, int)
349
if stop_revision > other_len:
350
raise errors.NoSuchRevision(self, stop_revision)
799
351
return other_history[self_len:stop_revision]
800
352
801
802
353
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
354
"""Pull in new perfect-fit revisions.
355
356
:param other: Another Branch to pull from
357
:param stop_revision: Updated until the given revision
358
:return: None
359
"""
360
raise NotImplementedError('update_revisions is abstract')
361
362
def revision_id_to_revno(self, revision_id):
363
"""Given a revision id, return its revno"""
364
if revision_id is None:
365
return 0
366
history = self.revision_history()
367
try:
368
return history.index(revision_id) + 1
369
except ValueError:
370
raise bzrlib.errors.NoSuchRevision(self, revision_id)
371
372
def get_rev_id(self, revno, history=None):
373
"""Find the revision id of the specified revno."""
374
if revno == 0:
375
return None
376
if history is None:
377
history = self.revision_history()
378
elif revno <= 0 or revno > len(history):
379
raise bzrlib.errors.NoSuchRevision(self, revno)
380
return history[revno - 1]
381
382
def pull(self, source, overwrite=False, stop_revision=None):
383
raise NotImplementedError('pull is abstract')
1052
384
1053
385
def basis_tree(self):
1054
386
"""Return `Tree` object for last revision.
1055
387
1056
388
If there are no revisions yet, return an `EmptyTree`.
1057
389
"""
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
390
return self.repository.revision_tree(self.last_revision())
1065
391
1066
392
def rename_one(self, from_rel, to_rel):
1067
393
"""Rename one file.
1068
394
1069
395
This can change the directory or the filename or both.
1070
396
"""
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
397
raise NotImplementedError('rename_one is abstract')
1116
398
1117
399
def move(self, from_paths, to_name):
1118
400
"""Rename files.
1124
406
1125
407
Note that to_name is only the last component of the new name;
1126
408
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)
409
410
This returns a list of (from_path, to_path) pairs for each
411
entry that is moved.
412
"""
413
raise NotImplementedError('move is abstract')
414
415
def get_parent(self):
416
"""Return the parent location of the branch.
417
418
This is the default location for push/pull/missing. The usual
419
pattern is that the user can override it by specifying a
420
location.
421
"""
422
raise NotImplementedError('get_parent is abstract')
423
424
def get_push_location(self):
425
"""Return the None or the location to push this branch to."""
426
raise NotImplementedError('get_push_location is abstract')
427
428
def set_push_location(self, location):
429
"""Set a new push location for this branch."""
430
raise NotImplementedError('set_push_location is abstract')
431
432
def set_parent(self, url):
433
raise NotImplementedError('set_parent is abstract')
434
435
@needs_write_lock
436
def update(self):
437
"""Synchronise this branch with the master branch if any.
438
439
:return: None or the last_revision pivoted out during the update.
440
"""
441
return None
442
443
def check_revno(self, revno):
444
"""\
445
Check whether a revno corresponds to any revision.
446
Zero (the NULL revision) is considered valid.
447
"""
448
if revno != 0:
449
self.check_real_revno(revno)
450
451
def check_real_revno(self, revno):
452
"""\
453
Check whether a revno corresponds to a real revision.
454
Zero (the NULL revision) is considered invalid
455
"""
456
if revno < 1 or revno > self.revno():
457
raise InvalidRevisionNumber(revno)
458
459
@needs_read_lock
460
def clone(self, *args, **kwargs):
461
"""Clone this branch into to_bzrdir preserving all semantic values.
462
463
revision_id: if not None, the revision history in the new branch will
464
be truncated to end with revision_id.
465
"""
466
# for API compatibility, until 0.8 releases we provide the old api:
467
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
468
# after 0.8 releases, the *args and **kwargs should be changed:
469
# def clone(self, to_bzrdir, revision_id=None):
470
if (kwargs.get('to_location', None) or
471
kwargs.get('revision', None) or
472
kwargs.get('basis_branch', None) or
473
(len(args) and isinstance(args[0], basestring))):
474
# backwards compatibility api:
475
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
476
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
477
# get basis_branch
478
if len(args) > 2:
479
basis_branch = args[2]
480
else:
481
basis_branch = kwargs.get('basis_branch', None)
482
if basis_branch:
483
basis = basis_branch.bzrdir
484
else:
485
basis = None
486
# get revision
487
if len(args) > 1:
488
revision_id = args[1]
489
else:
490
revision_id = kwargs.get('revision', None)
491
# get location
492
if len(args):
493
url = args[0]
494
else:
495
# no default to raise if not provided.
496
url = kwargs.get('to_location')
497
return self.bzrdir.clone(url,
498
revision_id=revision_id,
499
basis=basis).open_branch()
500
# new cleaner api.
501
# generate args by hand
502
if len(args) > 1:
503
revision_id = args[1]
504
else:
505
revision_id = kwargs.get('revision_id', None)
506
if len(args):
507
to_bzrdir = args[0]
508
else:
509
# no default to raise if not provided.
510
to_bzrdir = kwargs.get('to_bzrdir')
511
result = self._format.initialize(to_bzrdir)
512
self.copy_content_into(result, revision_id=revision_id)
513
return result
514
515
@needs_read_lock
516
def sprout(self, to_bzrdir, revision_id=None):
517
"""Create a new line of development from the branch, into to_bzrdir.
518
519
revision_id: if not None, the revision history in the new branch will
520
be truncated to end with revision_id.
521
"""
522
result = self._format.initialize(to_bzrdir)
523
self.copy_content_into(result, revision_id=revision_id)
524
result.set_parent(self.bzrdir.root_transport.base)
525
return result
526
527
@needs_read_lock
528
def copy_content_into(self, destination, revision_id=None):
529
"""Copy the content of self into destination.
530
531
revision_id: if not None, the revision history in the new branch will
532
be truncated to end with revision_id.
533
"""
534
new_history = self.revision_history()
535
if revision_id is not None:
536
try:
537
new_history = new_history[:new_history.index(revision_id) + 1]
538
except ValueError:
539
rev = self.repository.get_revision(revision_id)
540
new_history = rev.get_history(self.repository)[1:]
541
destination.set_revision_history(new_history)
542
parent = self.get_parent()
543
if parent:
544
destination.set_parent(parent)
545
546
@needs_read_lock
547
def check(self):
548
"""Check consistency of the branch.
549
550
In particular this checks that revisions given in the revision-history
551
do actually match up in the revision graph, and that they're all
552
present in the repository.
553
554
Callers will typically also want to check the repository.
555
556
:return: A BranchCheckResult.
557
"""
558
mainline_parent_id = None
559
for revision_id in self.revision_history():
560
try:
561
revision = self.repository.get_revision(revision_id)
562
except errors.NoSuchRevision, e:
563
raise errors.BzrCheckError("mainline revision {%s} not in repository"
564
% revision_id)
565
# In general the first entry on the revision history has no parents.
566
# But it's not illegal for it to have parents listed; this can happen
567
# in imports from Arch when the parents weren't reachable.
568
if mainline_parent_id is not None:
569
if mainline_parent_id not in revision.parent_ids:
570
raise errors.BzrCheckError("previous revision {%s} not listed among "
571
"parents of {%s}"
572
% (mainline_parent_id, revision_id))
573
mainline_parent_id = revision_id
574
return BranchCheckResult(self)
575
576
577
class BranchFormat(object):
578
"""An encapsulation of the initialization and open routines for a format.
579
580
Formats provide three things:
581
* An initialization routine,
582
* a format string,
583
* an open routine.
584
585
Formats are placed in an dict by their format string for reference
586
during branch opening. Its not required that these be instances, they
587
can be classes themselves with class methods - it simply depends on
588
whether state is needed for a given format or not.
589
590
Once a format is deprecated, just deprecate the initialize and open
591
methods on the format class. Do not deprecate the object, as the
592
object will be created every time regardless.
593
"""
594
595
_default_format = None
596
"""The default format used for new branches."""
597
598
_formats = {}
599
"""The known formats."""
600
601
@classmethod
602
def find_format(klass, a_bzrdir):
603
"""Return the format for the branch object in a_bzrdir."""
604
try:
605
transport = a_bzrdir.get_branch_transport(None)
606
format_string = transport.get("format").read()
607
return klass._formats[format_string]
608
except NoSuchFile:
609
raise NotBranchError(path=transport.base)
610
except KeyError:
611
raise errors.UnknownFormatError(format_string)
612
613
@classmethod
614
def get_default_format(klass):
615
"""Return the current default format."""
616
return klass._default_format
617
618
def get_format_string(self):
619
"""Return the ASCII format string that identifies this format."""
620
raise NotImplementedError(self.get_format_string)
621
622
def get_format_description(self):
623
"""Return the short format description for this format."""
624
raise NotImplementedError(self.get_format_string)
625
626
def initialize(self, a_bzrdir):
627
"""Create a branch of this format in a_bzrdir."""
628
raise NotImplementedError(self.initialize)
629
630
def is_supported(self):
631
"""Is this format supported?
632
633
Supported formats can be initialized and opened.
634
Unsupported formats may not support initialization or committing or
635
some other features depending on the reason for not being supported.
636
"""
637
return True
638
639
def open(self, a_bzrdir, _found=False):
640
"""Return the branch object for a_bzrdir
641
642
_found is a private parameter, do not use it. It is used to indicate
643
if format probing has already be done.
644
"""
645
raise NotImplementedError(self.open)
646
647
@classmethod
648
def register_format(klass, format):
649
klass._formats[format.get_format_string()] = format
650
651
@classmethod
652
def set_default_format(klass, format):
653
klass._default_format = format
654
655
@classmethod
656
def unregister_format(klass, format):
657
assert klass._formats[format.get_format_string()] is format
658
del klass._formats[format.get_format_string()]
659
660
def __str__(self):
661
return self.get_format_string().rstrip()
662
663
664
class BzrBranchFormat4(BranchFormat):
665
"""Bzr branch format 4.
666
667
This format has:
668
- a revision-history file.
669
- a branch-lock lock file [ to be shared with the bzrdir ]
670
"""
671
672
def get_format_description(self):
673
"""See BranchFormat.get_format_description()."""
674
return "Branch format 4"
675
676
def initialize(self, a_bzrdir):
677
"""Create a branch of this format in a_bzrdir."""
678
mutter('creating branch in %s', a_bzrdir.transport.base)
679
branch_transport = a_bzrdir.get_branch_transport(self)
680
utf8_files = [('revision-history', ''),
681
('branch-name', ''),
682
]
683
control_files = LockableFiles(branch_transport, 'branch-lock',
684
TransportLock)
685
control_files.create_lock()
686
control_files.lock_write()
687
try:
688
for file, content in utf8_files:
689
control_files.put_utf8(file, content)
690
finally:
691
control_files.unlock()
692
return self.open(a_bzrdir, _found=True)
693
694
def __init__(self):
695
super(BzrBranchFormat4, self).__init__()
696
self._matchingbzrdir = bzrdir.BzrDirFormat6()
697
698
def open(self, a_bzrdir, _found=False):
699
"""Return the branch object for a_bzrdir
700
701
_found is a private parameter, do not use it. It is used to indicate
702
if format probing has already be done.
703
"""
704
if not _found:
705
# we are being called directly and must probe.
706
raise NotImplementedError
707
return BzrBranch(_format=self,
708
_control_files=a_bzrdir._control_files,
709
a_bzrdir=a_bzrdir,
710
_repository=a_bzrdir.open_repository())
711
712
def __str__(self):
713
return "Bazaar-NG branch format 4"
714
715
716
class BzrBranchFormat5(BranchFormat):
717
"""Bzr branch format 5.
718
719
This format has:
720
- a revision-history file.
721
- a format string
722
- a lock dir guarding the branch itself
723
- all of this stored in a branch/ subdirectory
724
- works with shared repositories.
725
726
This format is new in bzr 0.8.
727
"""
728
729
def get_format_string(self):
730
"""See BranchFormat.get_format_string()."""
731
return "Bazaar-NG branch format 5\n"
732
733
def get_format_description(self):
734
"""See BranchFormat.get_format_description()."""
735
return "Branch format 5"
736
737
def initialize(self, a_bzrdir):
738
"""Create a branch of this format in a_bzrdir."""
739
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
740
branch_transport = a_bzrdir.get_branch_transport(self)
741
utf8_files = [('revision-history', ''),
742
('branch-name', ''),
743
]
744
control_files = LockableFiles(branch_transport, 'lock', LockDir)
745
control_files.create_lock()
746
control_files.lock_write()
747
control_files.put_utf8('format', self.get_format_string())
748
try:
749
for file, content in utf8_files:
750
control_files.put_utf8(file, content)
751
finally:
752
control_files.unlock()
753
return self.open(a_bzrdir, _found=True, )
754
755
def __init__(self):
756
super(BzrBranchFormat5, self).__init__()
757
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
758
759
def open(self, a_bzrdir, _found=False):
760
"""Return the branch object for a_bzrdir
761
762
_found is a private parameter, do not use it. It is used to indicate
763
if format probing has already be done.
764
"""
765
if not _found:
766
format = BranchFormat.find_format(a_bzrdir)
767
assert format.__class__ == self.__class__
768
transport = a_bzrdir.get_branch_transport(None)
769
control_files = LockableFiles(transport, 'lock', LockDir)
770
return BzrBranch5(_format=self,
771
_control_files=control_files,
772
a_bzrdir=a_bzrdir,
773
_repository=a_bzrdir.find_repository())
774
775
def __str__(self):
776
return "Bazaar-NG Metadir branch format 5"
777
778
779
class BranchReferenceFormat(BranchFormat):
780
"""Bzr branch reference format.
781
782
Branch references are used in implementing checkouts, they
783
act as an alias to the real branch which is at some other url.
784
785
This format has:
786
- A location file
787
- a format string
788
"""
789
790
def get_format_string(self):
791
"""See BranchFormat.get_format_string()."""
792
return "Bazaar-NG Branch Reference Format 1\n"
793
794
def get_format_description(self):
795
"""See BranchFormat.get_format_description()."""
796
return "Checkout reference format 1"
797
798
def initialize(self, a_bzrdir, target_branch=None):
799
"""Create a branch of this format in a_bzrdir."""
800
if target_branch is None:
801
# this format does not implement branch itself, thus the implicit
802
# creation contract must see it as uninitializable
803
raise errors.UninitializableFormat(self)
804
mutter('creating branch reference in %s', a_bzrdir.transport.base)
805
branch_transport = a_bzrdir.get_branch_transport(self)
806
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
807
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
808
branch_transport.put('format', StringIO(self.get_format_string()))
809
return self.open(a_bzrdir, _found=True)
810
811
def __init__(self):
812
super(BranchReferenceFormat, self).__init__()
813
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
814
815
def _make_reference_clone_function(format, a_branch):
816
"""Create a clone() routine for a branch dynamically."""
817
def clone(to_bzrdir, revision_id=None):
818
"""See Branch.clone()."""
819
return format.initialize(to_bzrdir, a_branch)
820
# cannot obey revision_id limits when cloning a reference ...
821
# FIXME RBC 20060210 either nuke revision_id for clone, or
822
# emit some sort of warning/error to the caller ?!
823
return clone
824
825
def open(self, a_bzrdir, _found=False):
826
"""Return the branch that the branch reference in a_bzrdir points at.
827
828
_found is a private parameter, do not use it. It is used to indicate
829
if format probing has already be done.
830
"""
831
if not _found:
832
format = BranchFormat.find_format(a_bzrdir)
833
assert format.__class__ == self.__class__
834
transport = a_bzrdir.get_branch_transport(None)
835
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
836
result = real_bzrdir.open_branch()
837
# this changes the behaviour of result.clone to create a new reference
838
# rather than a copy of the content of the branch.
839
# I did not use a proxy object because that needs much more extensive
840
# testing, and we are only changing one behaviour at the moment.
841
# If we decide to alter more behaviours - i.e. the implicit nickname
842
# then this should be refactored to introduce a tested proxy branch
843
# and a subclass of that for use in overriding clone() and ....
844
# - RBC 20060210
845
result.clone = self._make_reference_clone_function(result)
846
return result
847
848
849
# formats which have no format string are not discoverable
850
# and not independently creatable, so are not registered.
851
__default_format = BzrBranchFormat5()
852
BranchFormat.register_format(__default_format)
853
BranchFormat.register_format(BranchReferenceFormat())
854
BranchFormat.set_default_format(__default_format)
855
_legacy_formats = [BzrBranchFormat4(),
856
]
857
858
class BzrBranch(Branch):
859
"""A branch stored in the actual filesystem.
860
861
Note that it's "local" in the context of the filesystem; it doesn't
862
really matter if it's on an nfs/smb/afs/coda/... share, as long as
863
it's writable, and can be accessed via the normal filesystem API.
864
"""
865
866
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
867
relax_version_check=DEPRECATED_PARAMETER, _format=None,
868
_control_files=None, a_bzrdir=None, _repository=None):
869
"""Create new branch object at a particular location.
870
871
transport -- A Transport object, defining how to access files.
872
873
init -- If True, create new control files in a previously
874
unversioned directory. If False, the branch must already
875
be versioned.
876
877
relax_version_check -- If true, the usual check for the branch
878
version is not applied. This is intended only for
879
upgrade/recovery type use; it's not guaranteed that
880
all operations will work on old format branches.
881
"""
882
if a_bzrdir is None:
883
self.bzrdir = bzrdir.BzrDir.open(transport.base)
884
else:
885
self.bzrdir = a_bzrdir
886
self._transport = self.bzrdir.transport.clone('..')
887
self._base = self._transport.base
888
self._format = _format
889
if _control_files is None:
890
raise ValueError('BzrBranch _control_files is None')
891
self.control_files = _control_files
892
if deprecated_passed(init):
893
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
894
"deprecated as of bzr 0.8. Please use Branch.create().",
895
DeprecationWarning,
896
stacklevel=2)
897
if init:
898
# this is slower than before deprecation, oh well never mind.
899
# -> its deprecated.
900
self._initialize(transport.base)
901
self._check_format(_format)
902
if deprecated_passed(relax_version_check):
903
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
904
"relax_version_check parameter is deprecated as of bzr 0.8. "
905
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
906
"open() method.",
907
DeprecationWarning,
908
stacklevel=2)
909
if (not relax_version_check
910
and not self._format.is_supported()):
911
raise errors.UnsupportedFormatError(
912
'sorry, branch format %r not supported' % self._format,
913
['use a different bzr version',
914
'or remove the .bzr directory'
915
' and "bzr init" again'])
916
if deprecated_passed(transport):
917
warn("BzrBranch.__init__(transport=XXX...): The transport "
918
"parameter is deprecated as of bzr 0.8. "
919
"Please use Branch.open, or bzrdir.open_branch().",
920
DeprecationWarning,
921
stacklevel=2)
922
self.repository = _repository
923
924
def __str__(self):
925
return '%s(%r)' % (self.__class__.__name__, self.base)
926
927
__repr__ = __str__
928
929
def __del__(self):
930
# TODO: It might be best to do this somewhere else,
931
# but it is nice for a Branch object to automatically
932
# cache it's information.
933
# Alternatively, we could have the Transport objects cache requests
934
# See the earlier discussion about how major objects (like Branch)
935
# should never expect their __del__ function to run.
936
# XXX: cache_root seems to be unused, 2006-01-13 mbp
937
if hasattr(self, 'cache_root') and self.cache_root is not None:
938
try:
939
rmtree(self.cache_root)
940
except:
941
pass
942
self.cache_root = None
943
944
def _get_base(self):
945
return self._base
946
947
base = property(_get_base, doc="The URL for the root of this branch.")
948
949
def _finish_transaction(self):
950
"""Exit the current transaction."""
951
return self.control_files._finish_transaction()
952
953
def get_transaction(self):
954
"""Return the current active transaction.
955
956
If no transaction is active, this returns a passthrough object
957
for which all data is immediately flushed and no caching happens.
958
"""
959
# this is an explicit function so that we can do tricky stuff
960
# when the storage in rev_storage is elsewhere.
961
# we probably need to hook the two 'lock a location' and
962
# 'have a transaction' together more delicately, so that
963
# we can have two locks (branch and storage) and one transaction
964
# ... and finishing the transaction unlocks both, but unlocking
965
# does not. - RBC 20051121
966
return self.control_files.get_transaction()
967
968
def _set_transaction(self, transaction):
969
"""Set a new active transaction."""
970
return self.control_files._set_transaction(transaction)
971
972
def abspath(self, name):
973
"""See Branch.abspath."""
974
return self.control_files._transport.abspath(name)
975
976
def _check_format(self, format):
977
"""Identify the branch format if needed.
978
979
The format is stored as a reference to the format object in
980
self._format for code that needs to check it later.
981
982
The format parameter is either None or the branch format class
983
used to open this branch.
984
985
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
986
"""
987
if format is None:
988
format = BranchFormat.find_format(self.bzrdir)
989
self._format = format
990
mutter("got branch format %s", self._format)
991
992
@needs_read_lock
993
def get_root_id(self):
994
"""See Branch.get_root_id."""
995
tree = self.repository.revision_tree(self.last_revision())
996
return tree.inventory.root.file_id
997
998
def is_locked(self):
999
return self.control_files.is_locked()
1000
1001
def lock_write(self):
1002
# TODO: test for failed two phase locks. This is known broken.
1003
self.control_files.lock_write()
1004
self.repository.lock_write()
1005
1006
def lock_read(self):
1007
# TODO: test for failed two phase locks. This is known broken.
1008
self.control_files.lock_read()
1009
self.repository.lock_read()
1010
1011
def unlock(self):
1012
# TODO: test for failed two phase locks. This is known broken.
1013
try:
1014
self.repository.unlock()
1015
finally:
1016
self.control_files.unlock()
1017
1018
def peek_lock_mode(self):
1019
if self.control_files._lock_count == 0:
1020
return None
1021
else:
1022
return self.control_files._lock_mode
1023
1024
def get_physical_lock_status(self):
1025
return self.control_files.get_physical_lock_status()
1026
1027
@needs_read_lock
1028
def print_file(self, file, revision_id):
1029
"""See Branch.print_file."""
1030
return self.repository.print_file(file, revision_id)
1031
1032
@needs_write_lock
1033
def append_revision(self, *revision_ids):
1034
"""See Branch.append_revision."""
1035
for revision_id in revision_ids:
1036
mutter("add {%s} to revision-history" % revision_id)
1037
rev_history = self.revision_history()
1038
rev_history.extend(revision_ids)
1039
self.set_revision_history(rev_history)
1040
1041
@needs_write_lock
1042
def set_revision_history(self, rev_history):
1043
"""See Branch.set_revision_history."""
1044
self.control_files.put_utf8(
1045
'revision-history', '\n'.join(rev_history))
1046
transaction = self.get_transaction()
1047
history = transaction.map.find_revision_history()
1048
if history is not None:
1049
# update the revision history in the identity map.
1050
history[:] = list(rev_history)
1051
# this call is disabled because revision_history is
1052
# not really an object yet, and the transaction is for objects.
1053
# transaction.register_dirty(history)
1054
else:
1055
transaction.map.add_revision_history(rev_history)
1056
# this call is disabled because revision_history is
1057
# not really an object yet, and the transaction is for objects.
1058
# transaction.register_clean(history)
1059
1060
def get_revision_delta(self, revno):
1061
"""Return the delta for one revision.
1062
1063
The delta is relative to its mainline predecessor, or the
1064
empty tree for revision 1.
1065
"""
1066
assert isinstance(revno, int)
1067
rh = self.revision_history()
1068
if not (1 <= revno <= len(rh)):
1069
raise InvalidRevisionNumber(revno)
1070
1071
# revno is 1-based; list is 0-based
1072
1073
new_tree = self.repository.revision_tree(rh[revno-1])
1074
if revno == 1:
1075
old_tree = EmptyTree()
1076
else:
1077
old_tree = self.repository.revision_tree(rh[revno-2])
1078
return compare_trees(old_tree, new_tree)
1079
1080
@needs_read_lock
1081
def revision_history(self):
1082
"""See Branch.revision_history."""
1083
transaction = self.get_transaction()
1084
history = transaction.map.find_revision_history()
1085
if history is not None:
1086
mutter("cache hit for revision-history in %s", self)
1087
return list(history)
1088
history = [l.rstrip('\r\n') for l in
1089
self.control_files.get_utf8('revision-history').readlines()]
1090
transaction.map.add_revision_history(history)
1091
# this call is disabled because revision_history is
1092
# not really an object yet, and the transaction is for objects.
1093
# transaction.register_clean(history, precious=True)
1094
return list(history)
1095
1096
@needs_write_lock
1097
def update_revisions(self, other, stop_revision=None):
1098
"""See Branch.update_revisions."""
1099
other.lock_read()
1100
try:
1101
if stop_revision is None:
1102
stop_revision = other.last_revision()
1103
if stop_revision is None:
1104
# if there are no commits, we're done.
1105
return
1106
# whats the current last revision, before we fetch [and change it
1107
# possibly]
1108
last_rev = self.last_revision()
1109
# we fetch here regardless of whether we need to so that we pickup
1110
# filled in ghosts.
1111
self.fetch(other, stop_revision)
1112
my_ancestry = self.repository.get_ancestry(last_rev)
1113
if stop_revision in my_ancestry:
1114
# last_revision is a descendant of stop_revision
1115
return
1116
# stop_revision must be a descendant of last_revision
1117
stop_graph = self.repository.get_revision_graph(stop_revision)
1118
if last_rev is not None and last_rev not in stop_graph:
1119
# our previous tip is not merged into stop_revision
1120
raise errors.DivergedBranches(self, other)
1121
# make a new revision history from the graph
1122
current_rev_id = stop_revision
1123
new_history = []
1124
while current_rev_id not in (None, NULL_REVISION):
1125
new_history.append(current_rev_id)
1126
current_rev_id_parents = stop_graph[current_rev_id]
1170
1127
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
1128
current_rev_id = current_rev_id_parents[0]
1129
except IndexError:
1130
current_rev_id = None
1131
new_history.reverse()
1132
self.set_revision_history(new_history)
1133
finally:
1134
other.unlock()
1135
1136
def basis_tree(self):
1137
"""See Branch.basis_tree."""
1138
return self.repository.revision_tree(self.last_revision())
1139
1140
@deprecated_method(zero_eight)
1141
def working_tree(self):
1142
"""Create a Working tree object for this branch."""
1143
from bzrlib.transport.local import LocalTransport
1144
if (self.base.find('://') != -1 or
1145
not isinstance(self._transport, LocalTransport)):
1146
raise NoWorkingTree(self.base)
1147
return self.bzrdir.open_workingtree()
1148
1149
@needs_write_lock
1150
def pull(self, source, overwrite=False, stop_revision=None):
1151
"""See Branch.pull."""
1152
source.lock_read()
1153
try:
1154
old_count = len(self.revision_history())
1155
try:
1156
self.update_revisions(source,stop_revision)
1157
except DivergedBranches:
1158
if not overwrite:
1159
raise
1160
if overwrite:
1161
self.set_revision_history(source.revision_history())
1162
new_count = len(self.revision_history())
1163
return new_count - old_count
1164
finally:
1165
source.unlock()
1166
1167
def get_parent(self):
1168
"""See Branch.get_parent."""
1169
_locs = ['parent', 'pull', 'x-pull']
1170
assert self.base[-1] == '/'
1171
for l in _locs:
1172
try:
1173
return urlutils.join(self.base[:-1],
1174
self.control_files.get(l).read().strip('\n'))
1175
except NoSuchFile:
1176
pass
1177
return None
1178
1179
def get_push_location(self):
1180
"""See Branch.get_push_location."""
1181
config = bzrlib.config.BranchConfig(self)
1182
push_loc = config.get_user_option('push_location')
1183
return push_loc
1184
1185
def set_push_location(self, location):
1186
"""See Branch.set_push_location."""
1187
config = bzrlib.config.LocationConfig(self.base)
1188
config.set_user_option('push_location', location)
1189
1190
@needs_write_lock
1191
def set_parent(self, url):
1192
"""See Branch.set_parent."""
1193
# TODO: Maybe delete old location files?
1194
# URLs should never be unicode, even on the local fs,
1195
# FIXUP this and get_parent in a future branch format bump:
1196
# read and rewrite the file, and have the new format code read
1197
# using .get not .get_utf8. RBC 20060125
1198
if url is None:
1199
self.control_files._transport.delete('parent')
1200
else:
1201
if isinstance(url, unicode):
1202
try:
1203
url = url.encode('ascii')
1204
except UnicodeEncodeError:
1205
raise bzrlib.errors.InvalidURL(url,
1206
"Urls must be 7-bit ascii, "
1207
"use bzrlib.urlutils.escape")
1208
1209
url = urlutils.relative_url(self.base, url)
1210
self.control_files.put('parent', url + '\n')
1211
1212
def tree_config(self):
1213
return TreeConfig(self)
1214
1215
1216
class BzrBranch5(BzrBranch):
1217
"""A format 5 branch. This supports new features over plan branches.
1218
1219
It has support for a master_branch which is the data for bound branches.
1220
"""
1221
1222
def __init__(self,
1223
_format,
1224
_control_files,
1225
a_bzrdir,
1226
_repository):
1227
super(BzrBranch5, self).__init__(_format=_format,
1228
_control_files=_control_files,
1229
a_bzrdir=a_bzrdir,
1230
_repository=_repository)
1231
1232
@needs_write_lock
1233
def pull(self, source, overwrite=False, stop_revision=None):
1234
"""Updates branch.pull to be bound branch aware."""
1235
bound_location = self.get_bound_location()
1236
if source.base != bound_location:
1237
# not pulling from master, so we need to update master.
1238
master_branch = self.get_master_branch()
1239
if master_branch:
1240
master_branch.pull(source)
1241
source = master_branch
1242
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1243
1244
def get_bound_location(self):
1245
try:
1246
return self.control_files.get_utf8('bound').read()[:-1]
1247
except errors.NoSuchFile:
1248
return None
1249
1250
@needs_read_lock
1251
def get_master_branch(self):
1252
"""Return the branch we are bound to.
1253
1254
:return: Either a Branch, or None
1255
1256
This could memoise the branch, but if thats done
1257
it must be revalidated on each new lock.
1258
So for now we just don't memoise it.
1259
# RBC 20060304 review this decision.
1260
"""
1261
bound_loc = self.get_bound_location()
1262
if not bound_loc:
1263
return None
1264
try:
1265
return Branch.open(bound_loc)
1266
except (errors.NotBranchError, errors.ConnectionError), e:
1267
raise errors.BoundBranchConnectionFailure(
1268
self, bound_loc, e)
1269
1270
@needs_write_lock
1271
def set_bound_location(self, location):
1272
"""Set the target where this branch is bound to.
1273
1274
:param location: URL to the target branch
1275
"""
1276
if location:
1277
self.control_files.put_utf8('bound', location+'\n')
1278
else:
1279
try:
1280
self.control_files._transport.delete('bound')
1281
except NoSuchFile:
1282
return False
1283
return True
1284
1285
@needs_write_lock
1286
def bind(self, other):
1287
"""Bind the local branch the other branch.
1288
1289
:param other: The branch to bind to
1290
:type other: Branch
1291
"""
1292
# TODO: jam 20051230 Consider checking if the target is bound
1293
# It is debatable whether you should be able to bind to
1294
# a branch which is itself bound.
1295
# Committing is obviously forbidden,
1296
# but binding itself may not be.
1297
# Since we *have* to check at commit time, we don't
1298
# *need* to check here
1299
self.pull(other)
1300
1301
# we are now equal to or a suffix of other.
1302
1303
# Since we have 'pulled' from the remote location,
1304
# now we should try to pull in the opposite direction
1305
# in case the local tree has more revisions than the
1306
# remote one.
1307
# There may be a different check you could do here
1308
# rather than actually trying to install revisions remotely.
1309
# TODO: capture an exception which indicates the remote branch
1310
# is not writable.
1311
# If it is up-to-date, this probably should not be a failure
1312
1313
# lock other for write so the revision-history syncing cannot race
1314
other.lock_write()
1315
try:
1316
other.pull(self)
1317
# if this does not error, other now has the same last rev we do
1318
# it can only error if the pull from other was concurrent with
1319
# a commit to other from someone else.
1320
1321
# until we ditch revision-history, we need to sync them up:
1322
self.set_revision_history(other.revision_history())
1323
# now other and self are up to date with each other and have the
1324
# same revision-history.
1325
finally:
1326
other.unlock()
1327
1328
self.set_bound_location(other.base)
1329
1330
@needs_write_lock
1331
def unbind(self):
1332
"""If bound, unbind"""
1333
return self.set_bound_location(None)
1334
1335
@needs_write_lock
1336
def update(self):
1337
"""Synchronise this branch with the master branch if any.
1338
1339
:return: None or the last_revision that was pivoted out during the
1340
update.
1341
"""
1342
master = self.get_master_branch()
1343
if master is not None:
1344
old_tip = self.last_revision()
1345
self.pull(master, overwrite=True)
1346
if old_tip in self.repository.get_ancestry(self.last_revision()):
1347
return None
1348
return old_tip
1349
return None
1350
1351
1352
class BranchTestProviderAdapter(object):
1353
"""A tool to generate a suite testing multiple branch formats at once.
1354
1355
This is done by copying the test once for each transport and injecting
1356
the transport_server, transport_readonly_server, and branch_format
1357
classes into each copy. Each copy is also given a new id() to make it
1358
easy to identify.
1359
"""
1360
1361
def __init__(self, transport_server, transport_readonly_server, formats):
1362
self._transport_server = transport_server
1363
self._transport_readonly_server = transport_readonly_server
1364
self._formats = formats
1335
1365
1366
def adapt(self, test):
1367
result = TestSuite()
1368
for branch_format, bzrdir_format in self._formats:
1369
new_test = deepcopy(test)
1370
new_test.transport_server = self._transport_server
1371
new_test.transport_readonly_server = self._transport_readonly_server
1372
new_test.bzrdir_format = bzrdir_format
1373
new_test.branch_format = branch_format
1374
def make_new_test_id():
1375
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1376
return lambda: new_id
1377
new_test.id = make_new_test_id()
1378
result.addTest(new_test)
1379
return result
1380
1381
1382
class BranchCheckResult(object):
1383
"""Results of checking branch consistency.
1384
1385
:see: Branch.check
1386
"""
1387
1388
def __init__(self, branch):
1389
self.branch = branch
1390
1391
def report_results(self, verbose):
1392
"""Report the check results via trace.note.
1393
1394
:param verbose: Requests more detailed display of what was checked,
1395
if any.
1396
"""
1397
note('checked branch %s format %s',
1398
self.branch.base,
1399
self.branch._format)
1400
1336
1401
1337
1402
######################################################################
1338
1403
# predicates
1339
1404
1340
1405
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:
1348
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
1406
@deprecated_function(zero_eight)
1407
def is_control_file(*args, **kwargs):
1408
"""See bzrlib.workingtree.is_control_file."""
1409
return bzrlib.workingtree.is_control_file(*args, **kwargs)
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0