1
1
# Copyright (C) 2005, 2006 Canonical Ltd
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.
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.
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
22
from bzrlib.decorators import (needs_read_lock,
22
from bzrlib.decorators import *
24
23
import bzrlib.errors as errors
25
24
from bzrlib.errors import BzrError
26
25
from bzrlib.osutils import file_iterator, safe_unicode
27
from bzrlib.symbol_versioning import (deprecated_method,
26
from bzrlib.symbol_versioning import *
29
27
from bzrlib.trace import mutter, note
30
28
import bzrlib.transactions as transactions
31
29
import bzrlib.urlutils as urlutils
194
192
:param f: A file-like or string object whose contents should be copied.
196
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
199
def put_bytes(self, path, a_string):
200
"""Write a string of bytes.
202
:param path: The path to put the bytes, relative to the transport root.
203
:param string: A string object, whose exact bytes are to be copied.
205
self._transport.put_bytes(self._escape(path), a_string,
206
mode=self._file_mode)
194
self._transport.put(self._escape(path), file, mode=self._file_mode)
208
196
@needs_write_lock
209
197
def put_utf8(self, path, a_string):
210
198
"""Write a string, encoding as utf-8.
212
200
:param path: The path to put the string, relative to the transport root.
213
:param string: A string or unicode object whose contents should be copied.
201
:param string: A file-like or string object whose contents should be copied.
215
203
# IterableFile would not be needed if Transport.put took iterables
216
204
# instead of files. ADHB 2005-12-25
220
208
# these are valuable files which should have exact contents.
221
209
if not isinstance(a_string, basestring):
222
210
raise errors.BzrBadParameterNotString(a_string)
223
self.put_bytes(path, a_string.encode('utf-8'))
225
def leave_in_place(self):
226
"""Set this LockableFiles to not clear the physical lock on unlock."""
227
self._lock.leave_in_place()
229
def dont_leave_in_place(self):
230
"""Set this LockableFiles to clear the physical lock on unlock."""
231
self._lock.dont_leave_in_place()
233
def lock_write(self, token=None):
234
"""Lock this group of files for writing.
236
:param token: if this is already locked, then lock_write will fail
237
unless the token matches the existing lock.
238
:returns: a token if this instance supports tokens, otherwise None.
239
:raises TokenLockingNotSupported: when a token is given but this
240
instance doesn't support using token locks.
241
:raises MismatchedToken: if the specified token doesn't match the token
242
of the existing lock.
244
A token should be passed in if you know that you have locked the object
245
some other way, and need to synchronise this object's state with that
211
self.put(path, StringIO(a_string.encode('utf-8')))
213
def lock_write(self):
248
214
# mutter("lock write: %s (%s)", self, self._lock_count)
249
215
# TODO: Upgrade locking to support using a Transport,
250
216
# and potentially a remote locking protocol
251
217
if self._lock_mode:
252
218
if self._lock_mode != 'w' or not self.get_transaction().writeable():
253
219
raise errors.ReadOnlyError(self)
254
self._lock.validate_token(token)
255
220
self._lock_count += 1
256
return self._token_from_lock
258
token_from_lock = self._lock.lock_write(token=token)
222
self._lock.lock_write()
259
223
#note('write locking %s', self)
260
224
#traceback.print_stack()
261
225
self._lock_mode = 'w'
262
226
self._lock_count = 1
263
227
self._set_transaction(transactions.WriteTransaction())
264
self._token_from_lock = token_from_lock
265
return token_from_lock
267
229
def lock_read(self):
268
230
# mutter("lock read: %s (%s)", self, self._lock_count)
359
321
def break_lock(self):
360
322
raise NotImplementedError(self.break_lock)
362
def leave_in_place(self):
363
raise NotImplementedError(self.leave_in_place)
365
def dont_leave_in_place(self):
366
raise NotImplementedError(self.dont_leave_in_place)
368
def lock_write(self, token=None):
369
if token is not None:
370
raise errors.TokenLockingNotSupported(self)
324
def lock_write(self):
371
325
self._lock = self._transport.lock_write(self._escaped_name)
373
327
def lock_read(self):
383
337
def create(self, mode=None):
384
338
"""Create lock mechanism"""
385
339
# for old-style locks, create the file now
386
self._transport.put_bytes(self._escaped_name, '',
340
self._transport.put(self._escaped_name, StringIO(),
387
341
mode=self._file_modebits)
389
def validate_token(self, token):
390
if token is not None:
391
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
