← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Ian Clatworthy
  • Date: 2009-05-19 00:20:46 UTC
  • mto: (4376.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4377.
  • Revision ID: ian.clatworthy@canonical.com-20090519002046-qfxrlf4d73upe1h8
apply jam's review feedback

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