1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2008 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
17
17
from cStringIO import StringIO
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
22
from bzrlib.decorators import *
23
import bzrlib.errors as errors
24
from bzrlib.errors import BzrError
25
from bzrlib.osutils import file_iterator, safe_unicode
26
from bzrlib.symbol_versioning import *
27
from bzrlib.trace import mutter, note
28
import bzrlib.transactions as transactions
29
import bzrlib.urlutils as urlutils
32
from bzrlib.decorators import (
36
from bzrlib.symbol_versioning import (
32
42
# XXX: The tracking here of lock counts and whether the lock is held is
116
123
self._lock.break_lock()
118
125
def _escape(self, file_or_path):
126
"""DEPRECATED: Do not use outside this class"""
119
127
if not isinstance(file_or_path, basestring):
120
128
file_or_path = '/'.join(file_or_path)
121
129
if file_or_path == '':
123
return urlutils.escape(safe_unicode(file_or_path))
131
return urlutils.escape(osutils.safe_unicode(file_or_path))
125
133
def _find_modes(self):
126
"""Determine the appropriate modes for files and directories."""
134
"""Determine the appropriate modes for files and directories.
136
:deprecated: Replaced by BzrDir._find_modes.
128
139
st = self._transport.stat('.')
129
140
except errors.TransportNotPossible:
130
141
self._dir_mode = 0755
131
142
self._file_mode = 0644
133
self._dir_mode = st.st_mode & 07777
144
# Check the directory mode, but also make sure the created
145
# directories and files are read-write for this user. This is
146
# mostly a workaround for filesystems which lie about being able to
147
# write to a directory (cygwin & win32)
148
self._dir_mode = (st.st_mode & 07777) | 00700
134
149
# Remove the sticky and execute bits for files
135
150
self._file_mode = self._dir_mode & ~07111
136
if not self._set_dir_mode:
137
self._dir_mode = None
138
if not self._set_file_mode:
139
self._file_mode = None
152
@deprecated_method(deprecated_in((1, 6, 0)))
141
153
def controlfilename(self, file_or_path):
142
"""Return location relative to branch."""
154
"""Return location relative to branch.
156
:deprecated: Use Transport methods instead.
143
158
return self._transport.abspath(self._escape(file_or_path))
145
@deprecated_method(zero_eight)
146
def controlfile(self, file_or_path, mode='r'):
147
"""Open a control file for this branch.
149
There are two classes of file in a lockable directory: text
150
and binary. binary files are untranslated byte streams. Text
151
control files are stored with Unix newlines and in UTF-8, even
152
if the platform or locale defaults are different.
154
Such files are not openable in write mode : they are managed via
155
put and put_utf8 which atomically replace old versions using
159
relpath = self._escape(file_or_path)
160
# TODO: codecs.open() buffers linewise, so it was overloaded with
161
# a much larger buffer, do we need to do the same for getreader/getwriter?
163
return self.get(relpath)
165
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
167
return self.get_utf8(relpath)
169
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
171
raise BzrError("invalid controlfile mode %r" % mode)
161
@deprecated_method(deprecated_in((1, 5, 0)))
174
162
def get(self, relpath):
175
"""Get a file as a bytestream."""
163
"""Get a file as a bytestream.
165
:deprecated: Use a Transport instead of LockableFiles.
176
167
relpath = self._escape(relpath)
177
168
return self._transport.get(relpath)
171
@deprecated_method(deprecated_in((1, 5, 0)))
180
172
def get_utf8(self, relpath):
181
"""Get a file as a unicode stream."""
173
"""Get a file as a unicode stream.
175
:deprecated: Use a Transport instead of LockableFiles.
182
177
relpath = self._escape(relpath)
183
178
# DO NOT introduce an errors=replace here.
184
179
return codecs.getreader('utf-8')(self._transport.get(relpath))
186
181
@needs_write_lock
182
@deprecated_method(deprecated_in((1, 6, 0)))
187
183
def put(self, path, file):
190
186
:param path: The path to put the file, relative to the .bzr control
192
:param f: A file-like or string object whose contents should be copied.
194
self._transport.put(self._escape(path), file, mode=self._file_mode)
188
:param file: A file-like or string object whose contents should be copied.
190
:deprecated: Use Transport methods instead.
192
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
195
@deprecated_method(deprecated_in((1, 6, 0)))
196
def put_bytes(self, path, a_string):
197
"""Write a string of bytes.
199
:param path: The path to put the bytes, relative to the transport root.
200
:param a_string: A string object, whose exact bytes are to be copied.
202
:deprecated: Use Transport methods instead.
204
self._transport.put_bytes(self._escape(path), a_string,
205
mode=self._file_mode)
208
@deprecated_method(deprecated_in((1, 6, 0)))
197
209
def put_utf8(self, path, a_string):
198
210
"""Write a string, encoding as utf-8.
200
212
:param path: The path to put the string, relative to the transport root.
201
:param string: A file-like or string object whose contents should be copied.
213
:param string: A string or unicode object whose contents should be copied.
215
:deprecated: Use Transport methods instead.
203
217
# IterableFile would not be needed if Transport.put took iterables
204
218
# instead of files. ADHB 2005-12-25
208
222
# these are valuable files which should have exact contents.
209
223
if not isinstance(a_string, basestring):
210
224
raise errors.BzrBadParameterNotString(a_string)
211
self.put(path, StringIO(a_string.encode('utf-8')))
213
def lock_write(self):
214
# mutter("lock write: %s (%s)", self, self._lock_count)
225
self.put_bytes(path, a_string.encode('utf-8'))
227
def leave_in_place(self):
228
"""Set this LockableFiles to not clear the physical lock on unlock."""
229
self._lock.leave_in_place()
231
def dont_leave_in_place(self):
232
"""Set this LockableFiles to clear the physical lock on unlock."""
233
self._lock.dont_leave_in_place()
235
def lock_write(self, token=None):
236
"""Lock this group of files for writing.
238
:param token: if this is already locked, then lock_write will fail
239
unless the token matches the existing lock.
240
:returns: a token if this instance supports tokens, otherwise None.
241
:raises TokenLockingNotSupported: when a token is given but this
242
instance doesn't support using token locks.
243
:raises MismatchedToken: if the specified token doesn't match the token
244
of the existing lock.
246
A token should be passed in if you know that you have locked the object
247
some other way, and need to synchronise this object's state with that
215
250
# TODO: Upgrade locking to support using a Transport,
216
251
# and potentially a remote locking protocol
217
252
if self._lock_mode:
218
253
if self._lock_mode != 'w' or not self.get_transaction().writeable():
219
254
raise errors.ReadOnlyError(self)
255
self._lock.validate_token(token)
220
256
self._lock_count += 1
257
return self._token_from_lock
222
self._lock.lock_write()
223
#note('write locking %s', self)
259
token_from_lock = self._lock.lock_write(token=token)
224
260
#traceback.print_stack()
225
261
self._lock_mode = 'w'
226
262
self._lock_count = 1
227
263
self._set_transaction(transactions.WriteTransaction())
264
self._token_from_lock = token_from_lock
265
return token_from_lock
229
267
def lock_read(self):
230
# mutter("lock read: %s (%s)", self, self._lock_count)
231
268
if self._lock_mode:
232
assert self._lock_mode in ('r', 'w'), \
233
"invalid lock mode %r" % self._lock_mode
269
if self._lock_mode not in ('r', 'w'):
270
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
234
271
self._lock_count += 1
236
273
self._lock.lock_read()
237
#note('read locking %s', self)
238
274
#traceback.print_stack()
239
275
self._lock_mode = 'r'
240
276
self._lock_count = 1
added
removed
bzrlib/lockable_files.py
