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