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