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
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.symbol_versioning import deprecated_method, zero_eight
27
from bzrlib.trace import mutter
28
import bzrlib.transactions as transactions
37
31
class LockableFiles(object):
38
"""Object representing a set of related files locked within the same scope.
40
This coordinates access to the lock along with providing a transaction.
42
LockableFiles manage a lock count and can be locked repeatedly by
43
a single caller. (The underlying lock implementation generally does not
46
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'
32
"""Object representing a set of files locked within the same scope
38
If _lock_mode is true, a positive count of the number of times the
39
lock has been taken *by this process*. Others may have compatible
43
Lock object from bzrlib.lock.
59
def __init__(self, transport, lock_name, lock_class):
60
"""Create a LockableFiles group
49
# If set to False (by a plugin, etc) BzrBranch will not set the
50
# mode on created files or directories
62
:param transport: Transport pointing to the directory holding the
63
control files and lock.
64
:param lock_name: Name of the lock guarding these files.
65
:param lock_class: Class of lock strategy to use: typically
66
either LockDir or TransportLock.
54
def __init__(self, transport, lock_name):
68
56
self._transport = transport
69
57
self.lock_name = lock_name
70
58
self._transaction = None
71
self._lock_mode = None
74
esc_name = self._escape(lock_name)
75
self._lock = lock_class(transport, esc_name,
76
file_modebits=self._file_mode,
77
dir_modebits=self._dir_mode)
78
self._counted_lock = counted_lock.CountedLock(self._lock)
80
def create_lock(self):
83
This should normally be called only when the LockableFiles directory
84
is first created on disk.
86
self._lock.create(mode=self._dir_mode)
89
return '%s(%r)' % (self.__class__.__name__,
93
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()
62
if self._lock_mode or self._lock:
63
# XXX: This should show something every time, and be suitable for
64
# headless operation and embedding
65
from warnings import warn
66
warn("file group %r was not explicitly unlocked" % self)
102
69
def _escape(self, file_or_path):
103
"""DEPRECATED: Do not use outside this class"""
70
if not isinstance(file_or_path, basestring):
71
file_or_path = '/'.join(file_or_path)
104
72
if file_or_path == '':
106
return urlutils.escape(file_or_path)
74
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
108
76
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.
77
"""Determine the appropriate modes for files and directories."""
117
79
st = self._transport.stat('.')
118
80
except errors.TransportNotPossible:
119
self._dir_mode = 0o755
120
self._file_mode = 0o644
82
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
84
self._dir_mode = st.st_mode & 07777
127
85
# 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
86
self._file_mode = self._dir_mode & ~07111
87
if not self._set_dir_mode:
89
if not self._set_file_mode:
90
self._file_mode = None
92
def controlfilename(self, file_or_path):
93
"""Return location relative to branch."""
94
return self._transport.abspath(self._escape(file_or_path))
96
@deprecated_method(zero_eight)
97
def controlfile(self, file_or_path, mode='r'):
98
"""Open a control file for this branch.
100
There are two classes of file in a lockable directory: text
101
and binary. binary files are untranslated byte streams. Text
102
control files are stored with Unix newlines and in UTF-8, even
103
if the platform or locale defaults are different.
105
Such files are not openable in write mode : they are managed via
106
put and put_utf8 which atomically replace old versions using
110
relpath = self._escape(file_or_path)
111
#TODO: codecs.open() buffers linewise, so it was overloaded with
112
# a much larger buffer, do we need to do the same for getreader/getwriter?
114
return self.get(relpath)
116
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
118
return self.get_utf8(relpath)
120
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
122
raise BzrError("invalid controlfile mode %r" % mode)
125
def get(self, relpath):
126
"""Get a file as a bytestream."""
127
relpath = self._escape(relpath)
128
return self._transport.get(relpath)
131
def get_utf8(self, relpath):
132
"""Get a file as a unicode stream."""
133
relpath = self._escape(relpath)
134
# DO NOT introduce an errors=replace here.
135
return codecs.getreader('utf-8')(self._transport.get(relpath))
138
def put(self, path, file):
141
:param path: The path to put the file, relative to the .bzr control
143
:param f: A file-like or string object whose contents should be copied.
145
self._transport.put(self._escape(path), file, mode=self._file_mode)
148
def put_utf8(self, path, a_string):
149
"""Write a string, encoding as utf-8.
151
:param path: The path to put the string, relative to the transport root.
152
:param string: A file-like or string object whose contents should be copied.
154
# IterableFile would not be needed if Transport.put took iterables
155
# instead of files. ADHB 2005-12-25
156
# RBC 20060103 surely its not needed anyway, with codecs transcode
158
# JAM 20060103 We definitely don't want encode(..., 'replace')
159
# these are valuable files which should have exact contents.
160
if not isinstance(a_string, basestring):
161
raise errors.BzrBadParameterNotString(a_string)
162
self.put(path, StringIO(a_string.encode('utf-8')))
164
def lock_write(self):
165
# mutter("lock write: %s (%s)", self, self._lock_count)
166
# TODO: Upgrade locking to support using a Transport,
167
# and potentially a remote locking protocol
153
168
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)
169
if self._lock_mode != 'w':
170
raise ReadOnlyError(self)
158
171
self._lock_count += 1
159
return self._token_from_lock
161
token_from_lock = self._lock.lock_write(token=token)
162
# traceback.print_stack()
173
self._lock = self._transport.lock_write(
174
self._escape(self.lock_name))
163
175
self._lock_mode = 'w'
164
176
self._lock_count = 1
165
self._set_write_transaction()
166
self._token_from_lock = token_from_lock
167
return token_from_lock
177
self._set_transaction(transactions.PassThroughTransaction())
169
179
def lock_read(self):
180
# mutter("lock read: %s (%s)", self, self._lock_count)
170
181
if self._lock_mode:
171
if self._lock_mode not in ('r', 'w'):
172
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
182
assert self._lock_mode in ('r', 'w'), \
183
"invalid lock mode %r" % self._lock_mode
173
184
self._lock_count += 1
175
self._lock.lock_read()
176
# traceback.print_stack()
186
self._lock = self._transport.lock_read(
187
self._escape(self.lock_name))
177
188
self._lock_mode = 'r'
178
189
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)
190
self._set_transaction(transactions.ReadOnlyTransaction())
191
# 5K may be excessive, but hey, its a knob.
192
self.get_transaction().set_cache_size(5000)
192
194
def unlock(self):
195
# mutter("unlock: %s (%s)", self, self._lock_count)
193
196
if not self._lock_mode:
194
return lock.cant_unlock_not_held(self)
197
raise errors.BranchNotLocked(self)
195
198
if self._lock_count > 1:
196
199
self._lock_count -= 1
198
# traceback.print_stack()
199
201
self._finish_transaction()
204
self._lock_mode = None
207
"""Return true if this LockableFiles group is locked"""
208
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:
204
self._lock_mode = self._lock_count = None
222
206
def get_transaction(self):
223
207
"""Return the current active transaction.
added
removed
bzrlib/lockable_files.py
