1
# Copyright (C) 2005-2011 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
17
from __future__ import absolute_import
19
from .lazy_import import lazy_import
20
lazy_import(globals(), """
32
from .decorators import (
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
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
30
# XXX: The tracking here of lock counts and whether the lock is held is
31
# somewhat redundant with what's done in LockDir; the main difference is that
32
# LockableFiles permits reentrancy.
37
34
class LockableFiles(object):
38
35
"""Object representing a set of related files locked within the same scope.
40
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.
42
43
LockableFiles manage a lock count and can be locked repeatedly by
43
44
a single caller. (The underlying lock implementation generally does not
46
47
Instances of this class are often called control_files.
48
This class is now deprecated; code should move to using the Transport
49
directly for file operations and using the lock or CountedLock for
52
:ivar _lock: The real underlying lock (e.g. a LockDir)
53
:ivar _lock_count: If _lock_mode is true, a positive count of the number
54
of times the lock has been taken (and not yet released) *by this
55
process*, through this particular object instance.
56
:ivar _lock_mode: None, or 'r' or 'w'
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.
57
# _lock_mode: None, or 'r' or 'w'
59
# _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
59
67
def __init__(self, transport, lock_name, lock_class):
60
68
"""Create a LockableFiles group
62
:param transport: Transport pointing to the directory holding the
70
:param transport: Transport pointing to the directory holding the
63
71
control files and lock.
64
72
:param lock_name: Name of the lock guarding these files.
65
73
:param lock_class: Class of lock strategy to use: typically
66
74
either LockDir or TransportLock.
68
77
self._transport = transport
69
78
self.lock_name = lock_name
70
79
self._transaction = None
71
81
self._lock_mode = None
72
82
self._lock_count = 0
74
83
esc_name = self._escape(lock_name)
75
84
self._lock = lock_class(transport, esc_name,
76
85
file_modebits=self._file_mode,
77
86
dir_modebits=self._dir_mode)
78
self._counted_lock = counted_lock.CountedLock(self._lock)
80
88
def create_lock(self):
81
89
"""Create the lock.
88
96
def __repr__(self):
89
97
return '%s(%r)' % (self.__class__.__name__,
93
100
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
96
"""Break the lock of this lockable files group if it is held.
98
The current ui factory will be used to prompt for user conformation.
100
self._lock.break_lock()
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)
102
110
def _escape(self, file_or_path):
103
"""DEPRECATED: Do not use outside this class"""
111
if not isinstance(file_or_path, basestring):
112
file_or_path = '/'.join(file_or_path)
104
113
if file_or_path == '':
106
return urlutils.escape(file_or_path)
115
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
108
117
def _find_modes(self):
109
"""Determine the appropriate modes for files and directories.
111
:deprecated: Replaced by BzrDir._find_creation_modes.
113
# XXX: The properties created by this can be removed or deprecated
114
# once all the _get_text_store methods etc no longer use them.
118
"""Determine the appropriate modes for files and directories."""
117
120
st = self._transport.stat('.')
118
121
except errors.TransportNotPossible:
119
self._dir_mode = 0o755
120
self._file_mode = 0o644
122
self._dir_mode = 0755
123
self._file_mode = 0644
122
# Check the directory mode, but also make sure the created
123
# directories and files are read-write for this user. This is
124
# mostly a workaround for filesystems which lie about being able to
125
# write to a directory (cygwin & win32)
126
self._dir_mode = (st.st_mode & 0o7777) | 0o0700
125
self._dir_mode = st.st_mode & 07777
127
126
# Remove the sticky and execute bits for files
128
self._file_mode = self._dir_mode & ~0o7111
130
def leave_in_place(self):
131
"""Set this LockableFiles to not clear the physical lock on unlock."""
132
self._lock.leave_in_place()
134
def dont_leave_in_place(self):
135
"""Set this LockableFiles to clear the physical lock on unlock."""
136
self._lock.dont_leave_in_place()
138
def lock_write(self, token=None):
139
"""Lock this group of files for writing.
141
:param token: if this is already locked, then lock_write will fail
142
unless the token matches the existing lock.
143
:returns: a token if this instance supports tokens, otherwise None.
144
:raises TokenLockingNotSupported: when a token is given but this
145
instance doesn't support using token locks.
146
:raises MismatchedToken: if the specified token doesn't match the token
147
of the existing lock.
149
A token should be passed in if you know that you have locked the object
150
some other way, and need to synchronise this object's state with that
127
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)
207
# TODO: Upgrade locking to support using a Transport,
208
# and potentially a remote locking protocol
153
209
if self._lock_mode:
154
if (self._lock_mode != 'w'
155
or not self.get_transaction().writeable()):
156
raise errors.ReadOnlyError(self)
157
self._lock.validate_token(token)
210
if self._lock_mode != 'w' or not self.get_transaction().writeable():
211
raise ReadOnlyError(self)
158
212
self._lock_count += 1
159
return self._token_from_lock
161
token_from_lock = self._lock.lock_write(token=token)
162
# traceback.print_stack()
214
self._lock.lock_write()
215
#note('write locking %s', self)
216
#traceback.print_stack()
163
217
self._lock_mode = 'w'
164
218
self._lock_count = 1
165
self._set_write_transaction()
166
self._token_from_lock = token_from_lock
167
return token_from_lock
219
self._set_transaction(transactions.WriteTransaction())
169
221
def lock_read(self):
222
# mutter("lock read: %s (%s)", self, self._lock_count)
170
223
if self._lock_mode:
171
if self._lock_mode not in ('r', 'w'):
172
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
224
assert self._lock_mode in ('r', 'w'), \
225
"invalid lock mode %r" % self._lock_mode
173
226
self._lock_count += 1
175
228
self._lock.lock_read()
176
# traceback.print_stack()
229
#note('read locking %s', self)
230
#traceback.print_stack()
177
231
self._lock_mode = 'r'
178
232
self._lock_count = 1
179
self._set_read_transaction()
181
def _set_read_transaction(self):
182
"""Setup a read transaction."""
183
self._set_transaction(transactions.ReadOnlyTransaction())
184
# 5K may be excessive, but hey, its a knob.
185
self.get_transaction().set_cache_size(5000)
187
def _set_write_transaction(self):
188
"""Setup a write transaction."""
189
self._set_transaction(transactions.WriteTransaction())
191
@only_raises(errors.LockNotHeld, errors.LockBroken)
233
self._set_transaction(transactions.ReadOnlyTransaction())
234
# 5K may be excessive, but hey, its a knob.
235
self.get_transaction().set_cache_size(5000)
192
237
def unlock(self):
238
# mutter("unlock: %s (%s)", self, self._lock_count)
193
239
if not self._lock_mode:
194
return lock.cant_unlock_not_held(self)
240
raise errors.LockNotHeld(self)
195
241
if self._lock_count > 1:
196
242
self._lock_count -= 1
198
# traceback.print_stack()
244
#note('unlocking %s', self)
245
#traceback.print_stack()
199
246
self._finish_transaction()
204
self._lock_mode = None
248
self._lock_mode = self._lock_count = None
206
250
def is_locked(self):
207
251
"""Return true if this LockableFiles group is locked"""
208
252
return self._lock_count >= 1
210
def get_physical_lock_status(self):
211
"""Return physical lock status.
213
Returns true if a lock is held on the transport. If no lock is held, or
214
the underlying locking mechanism does not support querying lock
215
status, false is returned.
218
return self._lock.peek() is not None
219
except NotImplementedError:
222
254
def get_transaction(self):
223
255
"""Return the current active transaction.
added
removed
bzrlib/lockable_files.py
