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