1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
# Copyright (C) 2005, 2006 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
# XXX: Some consideration of the problems that might occur if there are
# files whose id differs only in case. That should probably be forbidden.
import errno
import os
from cStringIO import StringIO
import urllib
from warnings import warn
from bzrlib import (
errors,
osutils,
)
from bzrlib.weavefile import read_weave, write_weave_v5
from bzrlib.weave import WeaveFile, Weave
from bzrlib.store import TransportStore
from bzrlib.atomicfile import AtomicFile
from bzrlib.symbol_versioning import (deprecated_method,
zero_eight)
from bzrlib.trace import mutter
import bzrlib.ui
class VersionedFileStore(TransportStore):
"""Collection of many versioned files in a transport."""
# TODO: Rather than passing versionedfile_kwargs, perhaps pass in a
# transport factory callable?
def __init__(self, transport, prefixed=False, precious=False,
dir_mode=None, file_mode=None,
versionedfile_class=WeaveFile,
versionedfile_kwargs={},
escaped=False):
super(VersionedFileStore, self).__init__(transport,
dir_mode=dir_mode, file_mode=file_mode,
prefixed=prefixed, compressed=False, escaped=escaped)
self._precious = precious
self._versionedfile_class = versionedfile_class
self._versionedfile_kwargs = versionedfile_kwargs
def _clear_cache_id(self, file_id, transaction):
"""WARNING may lead to inconsistent object references for file_id.
Remove file_id from the transaction map.
NOT in the transaction api because theres no reliable way to clear
callers. So its here for very specialised use rather than having an
'api' that isn't.
"""
weave = transaction.map.find_weave(file_id)
if weave is not None:
mutter("old data in transaction in %s for %s", self, file_id)
# FIXME abstraction violation - transaction now has stale data.
transaction.map.remove_object(weave)
def filename(self, file_id):
"""Return the path relative to the transport root."""
file_id = osutils.safe_file_id(file_id)
return self._relpath(file_id)
def __iter__(self):
suffixes = self._versionedfile_class.get_suffixes()
ids = set()
for relpath in self._iter_files_recursive():
for suffix in suffixes:
if relpath.endswith(suffix):
# TODO: use standard remove_suffix function
escaped_id = os.path.basename(relpath[:-len(suffix)])
file_id = self._unescape(escaped_id)
if file_id not in ids:
ids.add(file_id)
yield file_id
break # only one suffix can match
def has_id(self, file_id):
file_id = osutils.safe_file_id(file_id)
suffixes = self._versionedfile_class.get_suffixes()
filename = self.filename(file_id)
for suffix in suffixes:
if not self._transport.has(filename + suffix):
return False
return True
def get_empty(self, file_id, transaction):
"""Get an empty weave, which implies deleting the existing one first."""
file_id = osutils.safe_file_id(file_id)
if self.has_id(file_id):
self.delete(file_id, transaction)
return self.get_weave_or_empty(file_id, transaction)
def delete(self, file_id, transaction):
"""Remove file_id from the store."""
file_id = osutils.safe_file_id(file_id)
suffixes = self._versionedfile_class.get_suffixes()
filename = self.filename(file_id)
for suffix in suffixes:
self._transport.delete(filename + suffix)
self._clear_cache_id(file_id, transaction)
def _get(self, file_id):
return self._transport.get(self.filename(file_id))
def _put(self, file_id, f):
fn = self.filename(file_id)
try:
return self._transport.put_file(fn, f, mode=self._file_mode)
except errors.NoSuchFile:
if not self._prefixed:
raise
self._transport.mkdir(os.path.dirname(fn), mode=self._dir_mode)
return self._transport.put_file(fn, f, mode=self._file_mode)
def get_weave(self, file_id, transaction, _filename=None):
"""Return the VersionedFile for file_id.
:param _filename: filename that would be returned from self.filename for
file_id. This is used to reduce duplicate filename calculations when
using 'get_weave_or_empty'. FOR INTERNAL USE ONLY.
"""
file_id = osutils.safe_file_id(file_id)
weave = transaction.map.find_weave(file_id)
if weave is not None:
#mutter("cache hit in %s for %s", self, file_id)
return weave
if _filename is None:
_filename = self.filename(file_id)
if transaction.writeable():
w = self._versionedfile_class(_filename, self._transport, self._file_mode,
**self._versionedfile_kwargs)
transaction.map.add_weave(file_id, w)
transaction.register_dirty(w)
else:
w = self._versionedfile_class(_filename,
self._transport,
self._file_mode,
create=False,
access_mode='r',
**self._versionedfile_kwargs)
transaction.map.add_weave(file_id, w)
transaction.register_clean(w, precious=self._precious)
return w
@deprecated_method(zero_eight)
def get_lines(self, file_id, rev_id, transaction):
"""Return text from a particular version of a weave.
Returned as a list of lines.
"""
file_id = osutils.safe_file_id(file_id)
w = self.get_weave(file_id, transaction)
return w.get_lines(rev_id)
def _make_new_versionedfile(self, file_id, transaction,
known_missing=False, _filename=None):
"""Make a new versioned file.
:param _filename: filename that would be returned from self.filename for
file_id. This is used to reduce duplicate filename calculations when
using 'get_weave_or_empty'. FOR INTERNAL USE ONLY.
"""
if not known_missing and self.has_id(file_id):
self.delete(file_id, transaction)
if _filename is None:
_filename = self.filename(file_id)
try:
# we try without making the directory first because thats optimising
# for the common case.
weave = self._versionedfile_class(_filename, self._transport, self._file_mode, create=True,
**self._versionedfile_kwargs)
except errors.NoSuchFile:
if not self._prefixed:
# unexpected error - NoSuchFile is expected to be raised on a
# missing dir only and that only occurs when we are prefixed.
raise
self._transport.mkdir(self.hash_prefix(file_id), mode=self._dir_mode)
weave = self._versionedfile_class(_filename, self._transport,
self._file_mode, create=True,
**self._versionedfile_kwargs)
return weave
def get_weave_or_empty(self, file_id, transaction):
"""Return a weave, or an empty one if it doesn't exist."""
# This is typically used from 'commit' and 'fetch/push/pull' where
# we scan across many versioned files once. As such the small overhead
# of calculating the filename before doing a cache lookup is more than
# compensated for by not calculating the filename when making new
# versioned files.
file_id = osutils.safe_file_id(file_id)
_filename = self.filename(file_id)
try:
return self.get_weave(file_id, transaction, _filename=_filename)
except errors.NoSuchFile:
weave = self._make_new_versionedfile(file_id, transaction,
known_missing=True, _filename=_filename)
transaction.map.add_weave(file_id, weave)
# has to be dirty - its able to mutate on its own.
transaction.register_dirty(weave)
return weave
@deprecated_method(zero_eight)
def put_weave(self, file_id, weave, transaction):
"""This is a deprecated API: It writes an entire collection of ids out.
This became inappropriate when we made a versioned file api which
tracks the state of the collection of versions for a single id.
Its maintained for backwards compatability but will only work on
weave stores - pre 0.8 repositories.
"""
file_id = osutils.safe_file_id(file_id)
self._put_weave(file_id, weave, transaction)
def _put_weave(self, file_id, weave, transaction):
"""Preserved here for upgrades-to-weaves to use."""
myweave = self._make_new_versionedfile(file_id, transaction)
myweave.join(weave)
@deprecated_method(zero_eight)
def add_text(self, file_id, rev_id, new_lines, parents, transaction):
"""This method was a shorthand for
vfile = self.get_weave_or_empty(file_id, transaction)
vfile.add_lines(rev_id, parents, new_lines)
"""
file_id = osutils.safe_file_id(file_id)
vfile = self.get_weave_or_empty(file_id, transaction)
vfile.add_lines(rev_id, parents, new_lines)
@deprecated_method(zero_eight)
def add_identical_text(self, file_id, old_rev_id, new_rev_id, parents,
transaction):
"""This method was a shorthand for
vfile = self.get_weave_or_empty(file_id, transaction)
vfile.clone_text(new_rev_id, old_rev_id, parents)
"""
file_id = osutils.safe_file_id(file_id)
old_rev_id = osutils.safe_revision_id(old_rev_id)
new_rev_id = osutils.safe_revision_id(new_rev_id)
vfile = self.get_weave_or_empty(file_id, transaction)
vfile.clone_text(new_rev_id, old_rev_id, parents)
def copy(self, source, result_id, transaction):
"""Copy the source versioned file to result_id in this store."""
self._clear_cache_id(result_id, transaction)
source.copy_to(self.filename(result_id), self._transport)
def copy_all_ids(self, store_from, pb=None, from_transaction=None,
to_transaction=None):
"""Copy all the file ids from store_from into self."""
if from_transaction is None:
warn("Please pass from_transaction into "
"versioned_store.copy_all_ids.", stacklevel=2)
if to_transaction is None:
warn("Please pass to_transaction into "
"versioned_store.copy_all_ids.", stacklevel=2)
if not store_from.listable():
raise errors.UnlistableStore(store_from)
ids = []
for count, file_id in enumerate(store_from):
if pb:
pb.update('listing files', count, count)
ids.append(file_id)
if pb:
pb.clear()
mutter('copy_all ids: %r', ids)
self.copy_multi(store_from, ids, pb=pb,
from_transaction=from_transaction,
to_transaction=to_transaction)
def copy_multi(self, from_store, file_ids, pb=None, from_transaction=None,
to_transaction=None):
"""Copy all the versions for multiple file_ids from from_store.
:param from_transaction: required current transaction in from_store.
"""
from bzrlib.transactions import PassThroughTransaction
assert isinstance(from_store, WeaveStore)
if from_transaction is None:
warn("WeaveStore.copy_multi without a from_transaction parameter "
"is deprecated. Please provide a from_transaction.",
DeprecationWarning,
stacklevel=2)
# we are reading one object - caching is irrelevant.
from_transaction = PassThroughTransaction()
if to_transaction is None:
warn("WeaveStore.copy_multi without a to_transaction parameter "
"is deprecated. Please provide a to_transaction.",
DeprecationWarning,
stacklevel=2)
# we are copying single objects, and there may be open tranasactions
# so again with the passthrough
to_transaction = PassThroughTransaction()
pb = bzrlib.ui.ui_factory.nested_progress_bar()
try:
file_ids = [osutils.safe_file_id(f) for f in file_ids]
for count, f in enumerate(file_ids):
mutter("copy weave {%s} into %s", f, self)
pb.update('copy', count, len(file_ids))
# if we have it in cache, its faster.
# joining is fast with knits, and bearable for weaves -
# indeed the new case can be optimised if needed.
target = self._make_new_versionedfile(f, to_transaction)
target.join(from_store.get_weave(f, from_transaction))
finally:
pb.finished()
def total_size(self):
count, bytes = super(VersionedFileStore, self).total_size()
return (count / len(self._versionedfile_class.get_suffixes())), bytes
WeaveStore = VersionedFileStore
|