1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2008, 2009 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
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from cStringIO import StringIO
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
22
from bzrlib.decorators import (needs_read_lock,
24
import bzrlib.errors as errors
25
from bzrlib.errors import BzrError
26
from bzrlib.osutils import file_iterator, safe_unicode
27
from bzrlib.symbol_versioning import (deprecated_method,
29
from bzrlib.trace import mutter, note
30
import bzrlib.transactions as transactions
31
import bzrlib.urlutils as urlutils
32
from bzrlib.decorators import (
34
37
# XXX: The tracking here of lock counts and whether the lock is held is
35
38
# somewhat redundant with what's done in LockDir; the main difference is that
36
39
# LockableFiles permits reentrancy.
41
class _LockWarner(object):
42
"""Hold a counter for a lock and warn if GCed while the count is >= 1.
44
This is separate from LockableFiles because putting a __del__ on
45
LockableFiles can result in uncollectable cycles.
48
def __init__(self, repr):
53
if self.lock_count >= 1:
54
# There should have been a try/finally to unlock this.
55
warnings.warn("%r was gc'd while locked" % self.repr)
38
58
class LockableFiles(object):
39
59
"""Object representing a set of related files locked within the same scope.
41
These files are used by a WorkingTree, Repository or Branch, and should
42
generally only be touched by that object.
44
LockableFiles also provides some policy on top of Transport for encoding
45
control files as utf-8.
61
This coordinates access to the lock along with providing a transaction.
47
63
LockableFiles manage a lock count and can be locked repeatedly by
48
64
a single caller. (The underlying lock implementation generally does not
51
67
Instances of this class are often called control_files.
69
This class is now deprecated; code should move to using the Transport
70
directly for file operations and using the lock or CountedLock for
53
This object builds on top of a Transport, which is used to actually write
54
the files to disk, and an OSLock or LockDir, which controls how access to
55
the files is controlled. The particular type of locking used is set when
56
the object is constructed. In older formats OSLocks are used everywhere.
57
in newer formats a LockDir is used for Repositories and Branches, and
58
OSLocks for the local filesystem.
73
:ivar _lock: The real underlying lock (e.g. a LockDir)
74
:ivar _counted_lock: A lock decorated with a semaphore, so that it
61
78
# _lock_mode: None, or 'r' or 'w'
63
80
# _lock_count: If _lock_mode is true, a positive count of the number of
64
# times the lock has been taken *by this process*.
66
# If set to False (by a plugin, etc) BzrBranch will not set the
67
# mode on created files or directories
81
# times the lock has been taken *by this process*.
71
83
def __init__(self, transport, lock_name, lock_class):
72
84
"""Create a LockableFiles group
74
:param transport: Transport pointing to the directory holding the
86
:param transport: Transport pointing to the directory holding the
75
87
control files and lock.
76
88
:param lock_name: Name of the lock guarding these files.
77
89
:param lock_class: Class of lock strategy to use: typically
118
123
self._lock.break_lock()
120
125
def _escape(self, file_or_path):
126
"""DEPRECATED: Do not use outside this class"""
121
127
if not isinstance(file_or_path, basestring):
122
128
file_or_path = '/'.join(file_or_path)
123
129
if file_or_path == '':
125
return urlutils.escape(safe_unicode(file_or_path))
131
return urlutils.escape(osutils.safe_unicode(file_or_path))
127
133
def _find_modes(self):
128
"""Determine the appropriate modes for files and directories."""
134
"""Determine the appropriate modes for files and directories.
136
:deprecated: Replaced by BzrDir._find_creation_modes.
138
# XXX: The properties created by this can be removed or deprecated
139
# once all the _get_text_store methods etc no longer use them.
130
142
st = self._transport.stat('.')
131
143
except errors.TransportNotPossible:
132
144
self._dir_mode = 0755
133
145
self._file_mode = 0644
135
self._dir_mode = st.st_mode & 07777
147
# Check the directory mode, but also make sure the created
148
# directories and files are read-write for this user. This is
149
# mostly a workaround for filesystems which lie about being able to
150
# write to a directory (cygwin & win32)
151
self._dir_mode = (st.st_mode & 07777) | 00700
136
152
# Remove the sticky and execute bits for files
137
153
self._file_mode = self._dir_mode & ~07111
138
if not self._set_dir_mode:
139
self._dir_mode = None
140
if not self._set_file_mode:
141
self._file_mode = None
143
def controlfilename(self, file_or_path):
144
"""Return location relative to branch."""
145
return self._transport.abspath(self._escape(file_or_path))
147
@deprecated_method(zero_eight)
148
def controlfile(self, file_or_path, mode='r'):
149
"""Open a control file for this branch.
151
There are two classes of file in a lockable directory: text
152
and binary. binary files are untranslated byte streams. Text
153
control files are stored with Unix newlines and in UTF-8, even
154
if the platform or locale defaults are different.
156
Such files are not openable in write mode : they are managed via
157
put and put_utf8 which atomically replace old versions using
161
relpath = self._escape(file_or_path)
162
# TODO: codecs.open() buffers linewise, so it was overloaded with
163
# a much larger buffer, do we need to do the same for getreader/getwriter?
165
return self.get(relpath)
167
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
169
return self.get_utf8(relpath)
171
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
173
raise BzrError("invalid controlfile mode %r" % mode)
176
def get(self, relpath):
177
"""Get a file as a bytestream."""
178
relpath = self._escape(relpath)
179
return self._transport.get(relpath)
182
def get_utf8(self, relpath):
183
"""Get a file as a unicode stream."""
184
relpath = self._escape(relpath)
185
# DO NOT introduce an errors=replace here.
186
return codecs.getreader('utf-8')(self._transport.get(relpath))
189
def put(self, path, file):
192
:param path: The path to put the file, relative to the .bzr control
194
:param f: A file-like or string object whose contents should be copied.
196
self._transport.put(self._escape(path), file, mode=self._file_mode)
199
def put_utf8(self, path, a_string):
200
"""Write a string, encoding as utf-8.
202
:param path: The path to put the string, relative to the transport root.
203
:param string: A file-like or string object whose contents should be copied.
205
# IterableFile would not be needed if Transport.put took iterables
206
# instead of files. ADHB 2005-12-25
207
# RBC 20060103 surely its not needed anyway, with codecs transcode
209
# JAM 20060103 We definitely don't want encode(..., 'replace')
210
# these are valuable files which should have exact contents.
211
if not isinstance(a_string, basestring):
212
raise errors.BzrBadParameterNotString(a_string)
213
self.put(path, StringIO(a_string.encode('utf-8')))
215
def lock_write(self):
216
# mutter("lock write: %s (%s)", self, self._lock_count)
155
def leave_in_place(self):
156
"""Set this LockableFiles to not clear the physical lock on unlock."""
157
self._lock.leave_in_place()
159
def dont_leave_in_place(self):
160
"""Set this LockableFiles to clear the physical lock on unlock."""
161
self._lock.dont_leave_in_place()
163
def lock_write(self, token=None):
164
"""Lock this group of files for writing.
166
:param token: if this is already locked, then lock_write will fail
167
unless the token matches the existing lock.
168
:returns: a token if this instance supports tokens, otherwise None.
169
:raises TokenLockingNotSupported: when a token is given but this
170
instance doesn't support using token locks.
171
:raises MismatchedToken: if the specified token doesn't match the token
172
of the existing lock.
174
A token should be passed in if you know that you have locked the object
175
some other way, and need to synchronise this object's state with that
217
178
# TODO: Upgrade locking to support using a Transport,
218
179
# and potentially a remote locking protocol
219
180
if self._lock_mode:
220
181
if self._lock_mode != 'w' or not self.get_transaction().writeable():
221
182
raise errors.ReadOnlyError(self)
222
self._lock_count += 1
183
self._lock.validate_token(token)
184
self._lock_warner.lock_count += 1
185
return self._token_from_lock
224
self._lock.lock_write()
225
#note('write locking %s', self)
187
token_from_lock = self._lock.lock_write(token=token)
226
188
#traceback.print_stack()
227
189
self._lock_mode = 'w'
229
self._set_transaction(transactions.WriteTransaction())
190
self._lock_warner.lock_count = 1
191
self._set_write_transaction()
192
self._token_from_lock = token_from_lock
193
return token_from_lock
231
195
def lock_read(self):
232
# mutter("lock read: %s (%s)", self, self._lock_count)
233
196
if self._lock_mode:
234
assert self._lock_mode in ('r', 'w'), \
235
"invalid lock mode %r" % self._lock_mode
236
self._lock_count += 1
197
if self._lock_mode not in ('r', 'w'):
198
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
self._lock_warner.lock_count += 1
238
201
self._lock.lock_read()
239
#note('read locking %s', self)
240
202
#traceback.print_stack()
241
203
self._lock_mode = 'r'
243
self._set_transaction(transactions.ReadOnlyTransaction())
244
# 5K may be excessive, but hey, its a knob.
245
self.get_transaction().set_cache_size(5000)
204
self._lock_warner.lock_count = 1
205
self._set_read_transaction()
207
def _set_read_transaction(self):
208
"""Setup a read transaction."""
209
self._set_transaction(transactions.ReadOnlyTransaction())
210
# 5K may be excessive, but hey, its a knob.
211
self.get_transaction().set_cache_size(5000)
213
def _set_write_transaction(self):
214
"""Setup a write transaction."""
215
self._set_transaction(transactions.WriteTransaction())
217
@only_raises(errors.LockNotHeld, errors.LockBroken)
247
218
def unlock(self):
248
# mutter("unlock: %s (%s)", self, self._lock_count)
249
219
if not self._lock_mode:
250
raise errors.LockNotHeld(self)
251
if self._lock_count > 1:
252
self._lock_count -= 1
220
return lock.cant_unlock_not_held(self)
221
if self._lock_warner.lock_count > 1:
222
self._lock_warner.lock_count -= 1
254
#note('unlocking %s', self)
255
224
#traceback.print_stack()
256
225
self._finish_transaction()
258
227
self._lock.unlock()
260
self._lock_mode = self._lock_count = None
229
self._lock_mode = self._lock_warner.lock_count = None
232
def _lock_count(self):
233
return self._lock_warner.lock_count
262
235
def is_locked(self):
263
236
"""Return true if this LockableFiles group is locked"""
264
return self._lock_count >= 1
237
return self._lock_warner.lock_count >= 1
266
239
def get_physical_lock_status(self):
267
240
"""Return physical lock status.
269
242
Returns true if a lock is held on the transport. If no lock is held, or
270
243
the underlying locking mechanism does not support querying lock
271
244
status, false is returned.
added
removed
bzrlib/lockable_files.py
