← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: John Arbash Meinel
  • Date: 2009-07-30 23:54:26 UTC
  • mto: This revision was merged to the branch mainline in revision 4580.
  • Revision ID: john@arbash-meinel.com-20090730235426-o8h73swbh7seqaf7
Update the breakin support to support CTRL-BREAK on Windows.

The signal handling code is very similar, but the testing code got a bit clumsy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from cStringIO import StringIO
 
18
 
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
19
21
import codecs
30
32
""")
31
33
 
32
34
from bzrlib.decorators import (
33
 
    only_raises,
 
35
    needs_read_lock,
 
36
    needs_write_lock,
 
37
    )
 
38
from bzrlib.symbol_versioning import (
 
39
    deprecated_in,
 
40
    deprecated_method,
34
41
    )
35
42
 
36
43
 
58
65
class LockableFiles(object):
59
66
    """Object representing a set of related files locked within the same scope.
60
67
 
61
 
    This coordinates access to the lock along with providing a transaction.
 
68
    These files are used by a WorkingTree, Repository or Branch, and should
 
69
    generally only be touched by that object.
 
70
 
 
71
    LockableFiles also provides some policy on top of Transport for encoding
 
72
    control files as utf-8.
62
73
 
63
74
    LockableFiles manage a lock count and can be locked repeatedly by
64
75
    a single caller.  (The underlying lock implementation generally does not
66
77
 
67
78
    Instances of this class are often called control_files.
68
79
 
 
80
    This object builds on top of a Transport, which is used to actually write
 
81
    the files to disk, and an OSLock or LockDir, which controls how access to
 
82
    the files is controlled.  The particular type of locking used is set when
 
83
    the object is constructed.  In older formats OSLocks are used everywhere.
 
84
    in newer formats a LockDir is used for Repositories and Branches, and
 
85
    OSLocks for the local filesystem.
 
86
 
69
87
    This class is now deprecated; code should move to using the Transport
70
88
    directly for file operations and using the lock or CountedLock for
71
89
    locking.
133
151
    def _find_modes(self):
134
152
        """Determine the appropriate modes for files and directories.
135
153
 
136
 
        :deprecated: Replaced by BzrDir._find_creation_modes.
 
154
        :deprecated: Replaced by BzrDir._find_modes.
137
155
        """
138
156
        # XXX: The properties created by this can be removed or deprecated
139
157
        # once all the _get_text_store methods etc no longer use them.
152
170
            # Remove the sticky and execute bits for files
153
171
            self._file_mode = self._dir_mode & ~07111
154
172
 
 
173
    @deprecated_method(deprecated_in((1, 6, 0)))
 
174
    def controlfilename(self, file_or_path):
 
175
        """Return location relative to branch.
 
176
 
 
177
        :deprecated: Use Transport methods instead.
 
178
        """
 
179
        return self._transport.abspath(self._escape(file_or_path))
 
180
 
 
181
    @needs_read_lock
 
182
    @deprecated_method(deprecated_in((1, 5, 0)))
 
183
    def get(self, relpath):
 
184
        """Get a file as a bytestream.
 
185
 
 
186
        :deprecated: Use a Transport instead of LockableFiles.
 
187
        """
 
188
        relpath = self._escape(relpath)
 
189
        return self._transport.get(relpath)
 
190
 
 
191
    @needs_read_lock
 
192
    @deprecated_method(deprecated_in((1, 5, 0)))
 
193
    def get_utf8(self, relpath):
 
194
        """Get a file as a unicode stream.
 
195
 
 
196
        :deprecated: Use a Transport instead of LockableFiles.
 
197
        """
 
198
        relpath = self._escape(relpath)
 
199
        # DO NOT introduce an errors=replace here.
 
200
        return codecs.getreader('utf-8')(self._transport.get(relpath))
 
201
 
 
202
    @needs_write_lock
 
203
    @deprecated_method(deprecated_in((1, 6, 0)))
 
204
    def put(self, path, file):
 
205
        """Write a file.
 
206
 
 
207
        :param path: The path to put the file, relative to the .bzr control
 
208
                     directory
 
209
        :param file: A file-like or string object whose contents should be copied.
 
210
 
 
211
        :deprecated: Use Transport methods instead.
 
212
        """
 
213
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
 
214
 
 
215
    @needs_write_lock
 
216
    @deprecated_method(deprecated_in((1, 6, 0)))
 
217
    def put_bytes(self, path, a_string):
 
218
        """Write a string of bytes.
 
219
 
 
220
        :param path: The path to put the bytes, relative to the transport root.
 
221
        :param a_string: A string object, whose exact bytes are to be copied.
 
222
 
 
223
        :deprecated: Use Transport methods instead.
 
224
        """
 
225
        self._transport.put_bytes(self._escape(path), a_string,
 
226
                                  mode=self._file_mode)
 
227
 
 
228
    @needs_write_lock
 
229
    @deprecated_method(deprecated_in((1, 6, 0)))
 
230
    def put_utf8(self, path, a_string):
 
231
        """Write a string, encoding as utf-8.
 
232
 
 
233
        :param path: The path to put the string, relative to the transport root.
 
234
        :param string: A string or unicode object whose contents should be copied.
 
235
 
 
236
        :deprecated: Use Transport methods instead.
 
237
        """
 
238
        # IterableFile would not be needed if Transport.put took iterables
 
239
        # instead of files.  ADHB 2005-12-25
 
240
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
241
        # file support ?
 
242
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
243
        # these are valuable files which should have exact contents.
 
244
        if not isinstance(a_string, basestring):
 
245
            raise errors.BzrBadParameterNotString(a_string)
 
246
        self.put_bytes(path, a_string.encode('utf-8'))
 
247
 
155
248
    def leave_in_place(self):
156
249
        """Set this LockableFiles to not clear the physical lock on unlock."""
157
250
        self._lock.leave_in_place()
214
307
        """Setup a write transaction."""
215
308
        self._set_transaction(transactions.WriteTransaction())
216
309
 
217
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
218
310
    def unlock(self):
219
311
        if not self._lock_mode:
220
312
            return lock.cant_unlock_not_held(self)