1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
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
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
17
from cStringIO import StringIO
32
from bzrlib.decorators import (
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
37
32
# XXX: The tracking here of lock counts and whether the lock is held is
38
33
# somewhat redundant with what's done in LockDir; the main difference is that
39
34
# 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)
58
36
class LockableFiles(object):
59
37
"""Object representing a set of related files locked within the same scope.
61
This coordinates access to the lock along with providing a transaction.
39
These files are used by a WorkingTree, Repository or Branch, and should
40
generally only be touched by that object.
42
LockableFiles also provides some policy on top of Transport for encoding
43
control files as utf-8.
63
45
LockableFiles manage a lock count and can be locked repeatedly by
64
46
a single caller. (The underlying lock implementation generally does not
67
49
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
73
:ivar _lock: The real underlying lock (e.g. a LockDir)
74
:ivar _counted_lock: A lock decorated with a semaphore, so that it
51
This object builds on top of a Transport, which is used to actually write
52
the files to disk, and an OSLock or LockDir, which controls how access to
53
the files is controlled. The particular type of locking used is set when
54
the object is constructed. In older formats OSLocks are used everywhere.
55
in newer formats a LockDir is used for Repositories and Branches, and
56
OSLocks for the local filesystem.
78
59
# _lock_mode: None, or 'r' or 'w'
80
61
# _lock_count: If _lock_mode is true, a positive count of the number of
81
# times the lock has been taken *by this process*.
62
# times the lock has been taken *by this process*.
64
# If set to False (by a plugin, etc) BzrBranch will not set the
65
# mode on created files or directories
83
69
def __init__(self, transport, lock_name, lock_class):
84
70
"""Create a LockableFiles group
86
:param transport: Transport pointing to the directory holding the
72
:param transport: Transport pointing to the directory holding the
87
73
control files and lock.
88
74
:param lock_name: Name of the lock guarding these files.
89
75
:param lock_class: Class of lock strategy to use: typically
90
76
either LockDir or TransportLock.
92
79
self._transport = transport
93
80
self.lock_name = lock_name
94
81
self._transaction = None
82
# Need to happen before _find_modes in case it throws an exception
83
# __del__ expects _lock_count to be available
95
84
self._lock_mode = None
96
self._lock_warner = _LockWarner(repr(self))
98
87
esc_name = self._escape(lock_name)
99
88
self._lock = lock_class(transport, esc_name,
100
89
file_modebits=self._file_mode,
101
90
dir_modebits=self._dir_mode)
102
self._counted_lock = counted_lock.CountedLock(self._lock)
104
92
def create_lock(self):
105
93
"""Create the lock.
123
119
self._lock.break_lock()
125
121
def _escape(self, file_or_path):
126
"""DEPRECATED: Do not use outside this class"""
127
122
if not isinstance(file_or_path, basestring):
128
123
file_or_path = '/'.join(file_or_path)
129
124
if file_or_path == '':
131
return urlutils.escape(osutils.safe_unicode(file_or_path))
126
return urlutils.escape(safe_unicode(file_or_path))
133
128
def _find_modes(self):
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.
129
"""Determine the appropriate modes for files and directories."""
142
131
st = self._transport.stat('.')
143
132
except errors.TransportNotPossible:
144
133
self._dir_mode = 0755
145
134
self._file_mode = 0644
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
self._dir_mode = st.st_mode & 07777
152
137
# Remove the sticky and execute bits for files
153
138
self._file_mode = self._dir_mode & ~07111
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
139
if not self._set_dir_mode:
140
self._dir_mode = None
141
if not self._set_file_mode:
142
self._file_mode = None
144
def controlfilename(self, file_or_path):
145
"""Return location relative to branch."""
146
return self._transport.abspath(self._escape(file_or_path))
148
@deprecated_method(zero_eight)
149
def controlfile(self, file_or_path, mode='r'):
150
"""Open a control file for this branch.
152
There are two classes of file in a lockable directory: text
153
and binary. binary files are untranslated byte streams. Text
154
control files are stored with Unix newlines and in UTF-8, even
155
if the platform or locale defaults are different.
157
Such files are not openable in write mode : they are managed via
158
put and put_utf8 which atomically replace old versions using
162
relpath = self._escape(file_or_path)
163
# TODO: codecs.open() buffers linewise, so it was overloaded with
164
# a much larger buffer, do we need to do the same for getreader/getwriter?
166
return self.get(relpath)
168
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
170
return self.get_utf8(relpath)
172
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
174
raise BzrError("invalid controlfile mode %r" % mode)
177
def get(self, relpath):
178
"""Get a file as a bytestream."""
179
relpath = self._escape(relpath)
180
return self._transport.get(relpath)
183
def get_utf8(self, relpath):
184
"""Get a file as a unicode stream."""
185
relpath = self._escape(relpath)
186
# DO NOT introduce an errors=replace here.
187
return codecs.getreader('utf-8')(self._transport.get(relpath))
190
def put(self, path, file):
193
:param path: The path to put the file, relative to the .bzr control
195
:param f: A file-like or string object whose contents should be copied.
197
self._transport.put(self._escape(path), file, mode=self._file_mode)
200
def put_utf8(self, path, a_string):
201
"""Write a string, encoding as utf-8.
203
:param path: The path to put the string, relative to the transport root.
204
:param string: A file-like or string object whose contents should be copied.
206
# IterableFile would not be needed if Transport.put took iterables
207
# instead of files. ADHB 2005-12-25
208
# RBC 20060103 surely its not needed anyway, with codecs transcode
210
# JAM 20060103 We definitely don't want encode(..., 'replace')
211
# these are valuable files which should have exact contents.
212
if not isinstance(a_string, basestring):
213
raise errors.BzrBadParameterNotString(a_string)
214
self.put(path, StringIO(a_string.encode('utf-8')))
216
def lock_write(self):
217
# mutter("lock write: %s (%s)", self, self._lock_count)
178
218
# TODO: Upgrade locking to support using a Transport,
179
219
# and potentially a remote locking protocol
180
220
if self._lock_mode:
181
221
if self._lock_mode != 'w' or not self.get_transaction().writeable():
182
222
raise errors.ReadOnlyError(self)
183
self._lock.validate_token(token)
184
self._lock_warner.lock_count += 1
185
return self._token_from_lock
223
self._lock_count += 1
187
token_from_lock = self._lock.lock_write(token=token)
225
self._lock.lock_write()
226
#note('write locking %s', self)
188
227
#traceback.print_stack()
189
228
self._lock_mode = 'w'
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
230
self._set_transaction(transactions.WriteTransaction())
195
232
def lock_read(self):
233
# mutter("lock read: %s (%s)", self, self._lock_count)
196
234
if self._lock_mode:
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
235
assert self._lock_mode in ('r', 'w'), \
236
"invalid lock mode %r" % self._lock_mode
237
self._lock_count += 1
201
239
self._lock.lock_read()
240
#note('read locking %s', self)
202
241
#traceback.print_stack()
203
242
self._lock_mode = 'r'
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)
244
self._set_transaction(transactions.ReadOnlyTransaction())
245
# 5K may be excessive, but hey, its a knob.
246
self.get_transaction().set_cache_size(5000)
218
248
def unlock(self):
249
# mutter("unlock: %s (%s)", self, self._lock_count)
219
250
if not self._lock_mode:
220
return lock.cant_unlock_not_held(self)
221
if self._lock_warner.lock_count > 1:
222
self._lock_warner.lock_count -= 1
251
raise errors.LockNotHeld(self)
252
if self._lock_count > 1:
253
self._lock_count -= 1
255
#note('unlocking %s', self)
224
256
#traceback.print_stack()
225
257
self._finish_transaction()
227
259
self._lock.unlock()
229
self._lock_mode = self._lock_warner.lock_count = None
232
def _lock_count(self):
233
return self._lock_warner.lock_count
261
self._lock_mode = self._lock_count = None
235
263
def is_locked(self):
236
264
"""Return true if this LockableFiles group is locked"""
237
return self._lock_warner.lock_count >= 1
265
return self._lock_count >= 1
239
267
def get_physical_lock_status(self):
240
268
"""Return physical lock status.
242
270
Returns true if a lock is held on the transport. If no lock is held, or
243
271
the underlying locking mechanism does not support querying lock
244
272
status, false is returned.
added
removed
bzrlib/lockable_files.py
