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 *
23
import bzrlib.errors as errors
24
from bzrlib.errors import LockError, ReadOnlyError
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
32
from bzrlib.decorators import (
30
37
# XXX: The tracking here of lock counts and whether the lock is held is
31
38
# somewhat redundant with what's done in LockDir; the main difference is that
32
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)
34
58
class LockableFiles(object):
35
59
"""Object representing a set of related files locked within the same scope.
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.
61
This coordinates access to the lock along with providing a transaction.
43
63
LockableFiles manage a lock count and can be locked repeatedly by
44
64
a single caller. (The underlying lock implementation generally does not
47
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
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.
73
:ivar _lock: The real underlying lock (e.g. a LockDir)
74
:ivar _counted_lock: A lock decorated with a semaphore, so that it
57
78
# _lock_mode: None, or 'r' or 'w'
59
80
# _lock_count: If _lock_mode is true, a positive count of the number of
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
81
# times the lock has been taken *by this process*.
67
83
def __init__(self, transport, lock_name, lock_class):
68
84
"""Create a LockableFiles group
70
:param transport: Transport pointing to the directory holding the
86
:param transport: Transport pointing to the directory holding the
71
87
control files and lock.
72
88
:param lock_name: Name of the lock guarding these files.
73
89
:param lock_class: Class of lock strategy to use: typically
74
90
either LockDir or TransportLock.
77
92
self._transport = transport
78
93
self.lock_name = lock_name
79
94
self._transaction = None
95
self._lock_mode = None
96
self._lock_warner = _LockWarner(repr(self))
81
self._lock_mode = None
83
98
esc_name = self._escape(lock_name)
84
99
self._lock = lock_class(transport, esc_name,
85
100
file_modebits=self._file_mode,
86
101
dir_modebits=self._dir_mode)
102
self._counted_lock = counted_lock.CountedLock(self._lock)
88
104
def create_lock(self):
89
105
"""Create the lock.
99
115
def __str__(self):
100
116
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
104
# XXX: This should show something every time, and be suitable for
105
# headless operation and embedding
106
from warnings import warn
107
warn("file group %r was not explicitly unlocked" % self)
118
def break_lock(self):
119
"""Break the lock of this lockable files group if it is held.
121
The current ui factory will be used to prompt for user conformation.
123
self._lock.break_lock()
110
125
def _escape(self, file_or_path):
126
"""DEPRECATED: Do not use outside this class"""
111
127
if not isinstance(file_or_path, basestring):
112
128
file_or_path = '/'.join(file_or_path)
113
129
if file_or_path == '':
115
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
131
return urlutils.escape(osutils.safe_unicode(file_or_path))
117
133
def _find_modes(self):
118
"""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.
120
142
st = self._transport.stat('.')
121
143
except errors.TransportNotPossible:
122
144
self._dir_mode = 0755
123
145
self._file_mode = 0644
125
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
126
152
# Remove the sticky and execute bits for files
127
153
self._file_mode = self._dir_mode & ~07111
128
if not self._set_dir_mode:
129
self._dir_mode = None
130
if not self._set_file_mode:
131
self._file_mode = None
133
def controlfilename(self, file_or_path):
134
"""Return location relative to branch."""
135
return self._transport.abspath(self._escape(file_or_path))
137
@deprecated_method(zero_eight)
138
def controlfile(self, file_or_path, mode='r'):
139
"""Open a control file for this branch.
141
There are two classes of file in a lockable directory: text
142
and binary. binary files are untranslated byte streams. Text
143
control files are stored with Unix newlines and in UTF-8, even
144
if the platform or locale defaults are different.
146
Such files are not openable in write mode : they are managed via
147
put and put_utf8 which atomically replace old versions using
151
relpath = self._escape(file_or_path)
152
# TODO: codecs.open() buffers linewise, so it was overloaded with
153
# a much larger buffer, do we need to do the same for getreader/getwriter?
155
return self.get(relpath)
157
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
159
return self.get_utf8(relpath)
161
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
163
raise BzrError("invalid controlfile mode %r" % mode)
166
def get(self, relpath):
167
"""Get a file as a bytestream."""
168
relpath = self._escape(relpath)
169
return self._transport.get(relpath)
172
def get_utf8(self, relpath):
173
"""Get a file as a unicode stream."""
174
relpath = self._escape(relpath)
175
# DO NOT introduce an errors=replace here.
176
return codecs.getreader('utf-8')(self._transport.get(relpath))
179
def put(self, path, file):
182
:param path: The path to put the file, relative to the .bzr control
184
:param f: A file-like or string object whose contents should be copied.
186
self._transport.put(self._escape(path), file, mode=self._file_mode)
189
def put_utf8(self, path, a_string):
190
"""Write a string, encoding as utf-8.
192
:param path: The path to put the string, relative to the transport root.
193
:param string: A file-like or string object whose contents should be copied.
195
# IterableFile would not be needed if Transport.put took iterables
196
# instead of files. ADHB 2005-12-25
197
# RBC 20060103 surely its not needed anyway, with codecs transcode
199
# JAM 20060103 We definitely don't want encode(..., 'replace')
200
# these are valuable files which should have exact contents.
201
if not isinstance(a_string, basestring):
202
raise errors.BzrBadParameterNotString(a_string)
203
self.put(path, StringIO(a_string.encode('utf-8')))
205
def lock_write(self):
206
# 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
207
178
# TODO: Upgrade locking to support using a Transport,
208
179
# and potentially a remote locking protocol
209
180
if self._lock_mode:
210
181
if self._lock_mode != 'w' or not self.get_transaction().writeable():
211
raise ReadOnlyError(self)
212
self._lock_count += 1
182
raise errors.ReadOnlyError(self)
183
self._lock.validate_token(token)
184
self._lock_warner.lock_count += 1
185
return self._token_from_lock
214
self._lock.lock_write()
215
#note('write locking %s', self)
187
token_from_lock = self._lock.lock_write(token=token)
216
188
#traceback.print_stack()
217
189
self._lock_mode = 'w'
219
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
221
195
def lock_read(self):
222
# mutter("lock read: %s (%s)", self, self._lock_count)
223
196
if self._lock_mode:
224
assert self._lock_mode in ('r', 'w'), \
225
"invalid lock mode %r" % self._lock_mode
226
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
228
201
self._lock.lock_read()
229
#note('read locking %s', self)
230
202
#traceback.print_stack()
231
203
self._lock_mode = 'r'
233
self._set_transaction(transactions.ReadOnlyTransaction())
234
# 5K may be excessive, but hey, its a knob.
235
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)
237
218
def unlock(self):
238
# mutter("unlock: %s (%s)", self, self._lock_count)
239
219
if not self._lock_mode:
240
raise errors.LockNotHeld(self)
241
if self._lock_count > 1:
242
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
244
#note('unlocking %s', self)
245
224
#traceback.print_stack()
246
225
self._finish_transaction()
248
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
250
235
def is_locked(self):
251
236
"""Return true if this LockableFiles group is locked"""
252
return self._lock_count >= 1
237
return self._lock_warner.lock_count >= 1
239
def get_physical_lock_status(self):
240
"""Return physical lock status.
242
Returns true if a lock is held on the transport. If no lock is held, or
243
the underlying locking mechanism does not support querying lock
244
status, false is returned.
247
return self._lock.peek() is not None
248
except NotImplementedError:
254
251
def get_transaction(self):
255
252
"""Return the current active transaction.
added
removed
bzrlib/lockable_files.py
