1
# Copyright (C) 2005 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.symbol_versioning import deprecated_method, zero_eight
27
from bzrlib.trace import mutter
28
import bzrlib.transactions as transactions
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 (
31
38
class LockableFiles(object):
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.
39
"""Object representing a set of related files locked within the same scope.
41
This coordinates access to the lock along with providing a transaction.
43
LockableFiles manage a lock count and can be locked repeatedly by
44
a single caller. (The underlying lock implementation generally does not
47
Instances of this class are often called control_files.
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'
49
# If set to False (by a plugin, etc) BzrBranch will not set the
50
# mode on created files or directories
60
def __init__(self, transport, lock_name, lock_class):
61
"""Create a LockableFiles group
54
def __init__(self, transport, lock_name):
63
:param transport: Transport pointing to the directory holding the
64
control files and lock.
65
:param lock_name: Name of the lock guarding these files.
66
:param lock_class: Class of lock strategy to use: typically
67
either LockDir or TransportLock.
56
69
self._transport = transport
57
70
self.lock_name = lock_name
58
71
self._transaction = None
72
self._lock_mode = None
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)
75
esc_name = self._escape(lock_name)
76
self._lock = lock_class(transport, esc_name,
77
file_modebits=self._file_mode,
78
dir_modebits=self._dir_mode)
79
self._counted_lock = counted_lock.CountedLock(self._lock)
81
def create_lock(self):
84
This should normally be called only when the LockableFiles directory
85
is first created on disk.
87
self._lock.create(mode=self._dir_mode)
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()
69
103
def _escape(self, file_or_path):
104
"""DEPRECATED: Do not use outside this class"""
70
105
if not isinstance(file_or_path, basestring):
71
106
file_or_path = '/'.join(file_or_path)
72
107
if file_or_path == '':
74
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
109
return urlutils.escape(osutils.safe_unicode(file_or_path))
76
111
def _find_modes(self):
77
"""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.
80
st = self._transport.stat('.')
81
except errors.NoSuchFile:
82
# The .bzr/ directory doesn't exist, try to
83
# inherit the permissions from the parent directory
84
# but only try 1 level up
85
temp_transport = self._transport.clone('..')
86
st = temp_transport.stat('.')
87
except (errors.TransportNotPossible, errors.NoSuchFile):
120
st = self._transport.stat('.')
121
except errors.TransportNotPossible:
88
122
self._dir_mode = 0755
89
123
self._file_mode = 0644
91
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
92
130
# Remove the sticky and execute bits for files
93
131
self._file_mode = self._dir_mode & ~07111
94
if not self._set_dir_mode:
96
if not self._set_file_mode:
97
self._file_mode = None
99
def controlfilename(self, file_or_path):
100
"""Return location relative to branch."""
101
return self._transport.abspath(self._escape(file_or_path))
103
@deprecated_method(zero_eight)
104
def controlfile(self, file_or_path, mode='r'):
105
"""Open a control file for this branch.
107
There are two classes of file in a lockable directory: text
108
and binary. binary files are untranslated byte streams. Text
109
control files are stored with Unix newlines and in UTF-8, even
110
if the platform or locale defaults are different.
112
Such files are not openable in write mode : they are managed via
113
put and put_utf8 which atomically replace old versions using
117
relpath = self._escape(file_or_path)
118
#TODO: codecs.open() buffers linewise, so it was overloaded with
119
# a much larger buffer, do we need to do the same for getreader/getwriter?
121
return self.get(relpath)
123
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
125
return self.get_utf8(relpath)
127
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
129
raise BzrError("invalid controlfile mode %r" % mode)
132
def get(self, relpath):
133
"""Get a file as a bytestream."""
134
relpath = self._escape(relpath)
135
return self._transport.get(relpath)
138
def get_utf8(self, relpath):
139
"""Get a file as a unicode stream."""
140
relpath = self._escape(relpath)
141
# DO NOT introduce an errors=replace here.
142
return codecs.getreader('utf-8')(self._transport.get(relpath))
145
def put(self, path, file):
148
:param path: The path to put the file, relative to the .bzr control
150
:param f: A file-like or string object whose contents should be copied.
152
self._transport.put(self._escape(path), file, mode=self._file_mode)
155
def put_utf8(self, path, a_string):
156
"""Write a string, encoding as utf-8.
158
:param path: The path to put the string, relative to the transport root.
159
:param string: A file-like or string object whose contents should be copied.
161
# IterableFile would not be needed if Transport.put took iterables
162
# instead of files. ADHB 2005-12-25
163
# RBC 20060103 surely its not needed anyway, with codecs transcode
165
# JAM 20060103 We definitely don't want encode(..., 'replace')
166
# these are valuable files which should have exact contents.
167
if not isinstance(a_string, basestring):
168
raise errors.BzrBadParameterNotString(a_string)
169
self.put(path, StringIO(a_string.encode('utf-8')))
171
def lock_write(self):
172
mutter("lock write: %s (%s)", self, self._lock_count)
173
# TODO: Upgrade locking to support using a Transport,
174
# 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
175
156
if self._lock_mode:
176
if self._lock_mode != 'w':
177
raise ReadOnlyError("can't upgrade to a write lock from %r" %
157
if (self._lock_mode != 'w'
158
or not self.get_transaction().writeable()):
159
raise errors.ReadOnlyError(self)
160
self._lock.validate_token(token)
179
161
self._lock_count += 1
162
return self._token_from_lock
181
self._lock = self._transport.lock_write(
182
self._escape(self.lock_name))
164
token_from_lock = self._lock.lock_write(token=token)
165
#traceback.print_stack()
183
166
self._lock_mode = 'w'
184
167
self._lock_count = 1
185
self._set_transaction(transactions.PassThroughTransaction())
168
self._set_write_transaction()
169
self._token_from_lock = token_from_lock
170
return token_from_lock
187
172
def lock_read(self):
188
mutter("lock read: %s (%s)", self, self._lock_count)
189
173
if self._lock_mode:
190
assert self._lock_mode in ('r', 'w'), \
191
"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,))
192
176
self._lock_count += 1
194
self._lock = self._transport.lock_read(
195
self._escape(self.lock_name))
178
self._lock.lock_read()
179
#traceback.print_stack()
196
180
self._lock_mode = 'r'
197
181
self._lock_count = 1
198
self._set_transaction(transactions.ReadOnlyTransaction())
199
# 5K may be excessive, but hey, its a knob.
200
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)
202
195
def unlock(self):
203
mutter("unlock: %s (%s)", self, self._lock_count)
204
196
if not self._lock_mode:
205
raise LockError('branch %r is not locked' % (self))
197
return lock.cant_unlock_not_held(self)
207
198
if self._lock_count > 1:
208
199
self._lock_count -= 1
201
#traceback.print_stack()
210
202
self._finish_transaction()
213
self._lock_mode = self._lock_count = None
206
self._lock_mode = self._lock_count = None
209
"""Return true if this LockableFiles group is locked"""
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:
215
224
def get_transaction(self):
216
225
"""Return the current active transaction.
added
removed
bzrlib/lockable_files.py
