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