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