annotate MoinMoin/caching.py @ 3878:b13a58a18dac

caching module backported from 1.8 (file-like new api, old api still as is)
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sat, 19 Jul 2008 14:36:38 +0200
parents 39456a5dc4e8
children f042906b346e
rev   line source
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
1 # -*- coding: iso-8859-1 -*-
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
2 """
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
3 MoinMoin caching module
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
4
1918
bb2e053067fb fixing copyright headers: remove umlauts (encoding troubles), make epydoc compatible, reformat
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1898
diff changeset
5 @copyright: 2001-2004 by Juergen Hermann <jh@web.de>,
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
6 2006-2008 MoinMoin:ThomasWaldmann,
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
7 2008 MoinMoin:ThomasPfaff
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
8 @license: GNU GPL, see COPYING for details.
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
9 """
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
10
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
11 import os
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
12 import shutil
1647
c0cb0884f7ec use tempfile.mkstemp to avoid renaming trouble (ported from 1.5)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1638
diff changeset
13 import tempfile
1316
c4f6af5ee295 Mute the tempnam warning in the caching module.
Alexander Schremmer <alex AT alexanderweb DOT de>
parents: 1309
diff changeset
14
3127
ea5383222f2f refactored misc. modules to use own logger instead of request.log
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2841
diff changeset
15 from MoinMoin import log
ea5383222f2f refactored misc. modules to use own logger instead of request.log
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2841
diff changeset
16 logging = log.getLogger(__name__)
ea5383222f2f refactored misc. modules to use own logger instead of request.log
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2841
diff changeset
17
1898
b5e94fec8669 caching: mkstemp uses 0600 to create files, we need chmod to change them to our preferred file mode
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1793
diff changeset
18 from MoinMoin import config
1793
2a4caa295346 Eclipse PyDev Check: fixed lots of its errors and warnings
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1791
diff changeset
19 from MoinMoin.util import filesys, lock, pickle, PICKLE_PROTOCOL
931
141083b64fb1 whitespace and minor style changes only
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 902
diff changeset
20
1316
c4f6af5ee295 Mute the tempnam warning in the caching module.
Alexander Schremmer <alex AT alexanderweb DOT de>
parents: 1309
diff changeset
21
1637
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
22 class CacheError(Exception):
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
23 """ raised if we have trouble reading or writing to the cache """
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
24 pass
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
25
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
26
1936
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
27 def get_arena_dir(request, arena, scope):
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
28 if scope == 'page_or_wiki': # XXX DEPRECATED, remove later
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
29 if isinstance(arena, str):
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
30 return os.path.join(request.cfg.cache_dir, request.cfg.siteid, arena)
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
31 else: # arena is in fact a page object
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
32 return arena.getPagePath('cache', check_create=1)
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
33 elif scope == 'item': # arena is a Page instance
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
34 # we could move cache out of the page directory and store it to cache_dir
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
35 return arena.getPagePath('cache', check_create=1)
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
36 elif scope == 'wiki':
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
37 return os.path.join(request.cfg.cache_dir, request.cfg.siteid, arena)
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
38 elif scope == 'farm':
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
39 return os.path.join(request.cfg.cache_dir, '__common__', arena)
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
40 return None
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
41
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
42
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
43 def get_cache_list(request, arena, scope):
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
44 arena_dir = get_arena_dir(request, arena, scope)
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
45 try:
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
46 return filesys.dclistdir(arena_dir)
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
47 except OSError:
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
48 return []
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
49
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
50
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
51 class CacheEntry:
2238
529a3c5e6d0e add use_encode parameter to caching - useful for readable cache files. this re-adds similar functionality that was removed in changeset 5070d0358544
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1936
diff changeset
52 def __init__(self, request, arena, key, scope='page_or_wiki', do_locking=True,
529a3c5e6d0e add use_encode parameter to caching - useful for readable cache files. this re-adds similar functionality that was removed in changeset 5070d0358544
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1936
diff changeset
53 use_pickle=False, use_encode=False):
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
54 """ init a cache entry
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
55 @param request: the request object
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
56 @param arena: either a string or a page object, when we want to use
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
57 page local cache area
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
58 @param key: under which key we access the cache content
681
2d5883e4b82c scope == {'item', 'wiki', 'farm'} for caching
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 680
diff changeset
59 @param scope: the scope where we are caching:
2d5883e4b82c scope == {'item', 'wiki', 'farm'} for caching
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 680
diff changeset
60 'item' - an item local cache
2d5883e4b82c scope == {'item', 'wiki', 'farm'} for caching
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 680
diff changeset
61 'wiki' - a wiki local cache
2d5883e4b82c scope == {'item', 'wiki', 'farm'} for caching
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 680
diff changeset
62 'farm' - a cache for the whole farm
2238
529a3c5e6d0e add use_encode parameter to caching - useful for readable cache files. this re-adds similar functionality that was removed in changeset 5070d0358544
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1936
diff changeset
63 @param do_locking: if there should be a lock, normally True
529a3c5e6d0e add use_encode parameter to caching - useful for readable cache files. this re-adds similar functionality that was removed in changeset 5070d0358544
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1936
diff changeset
64 @param use_pickle: if data should be pickled/unpickled (nice for arbitrary cache content)
529a3c5e6d0e add use_encode parameter to caching - useful for readable cache files. this re-adds similar functionality that was removed in changeset 5070d0358544
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1936
diff changeset
65 @param use_encode: if data should be encoded/decoded (nice for readable cache files)
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
66 """
412
481c432b3d11 fix some error handlers, logging for caching lock failures
Thomas Waldmann <tw@waldmann-edv.de>
parents: 402
diff changeset
67 self.request = request
1307
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
68 self.key = key
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
69 self.locking = do_locking
1638
5070d0358544 caching: move use_pickle to __init__, remove unused encode/decode args from .content()/.update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1637
diff changeset
70 self.use_pickle = use_pickle
2238
529a3c5e6d0e add use_encode parameter to caching - useful for readable cache files. this re-adds similar functionality that was removed in changeset 5070d0358544
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1936
diff changeset
71 self.use_encode = use_encode
1936
adcdb9cc9258 caching.get_cache_list
Johannes Berg <johannes AT sipsolutions DOT net>
parents: 1920
diff changeset
72 self.arena_dir = get_arena_dir(request, arena, scope)
1429
1d55eff67af6 check for non-existing dir before calling os.makedirs
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1428
diff changeset
73 if not os.path.exists(self.arena_dir):
1428
8a89649ab5f0 remove util.filesys.make[dD]irs - not needed any more due to os.umask() use
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1317
diff changeset
74 os.makedirs(self.arena_dir)
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
75 self._fname = os.path.join(self.arena_dir, key)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
76
902
6cc24670fd0f Speeded up linkto: search by avoiding read locks on pagelinks retrieval.
Alexander Schremmer <alex AT alexanderweb DOT de>
parents: 683
diff changeset
77 if self.locking:
412
481c432b3d11 fix some error handlers, logging for caching lock failures
Thomas Waldmann <tw@waldmann-edv.de>
parents: 402
diff changeset
78 self.lock_dir = os.path.join(self.arena_dir, '__lock__')
1309
238c43cb8877 lock: LazyReadLock, LazyWriteLock == do nothing. Only for POSIX OS and POSIX style of code using that kind of locks (see comments there).
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1307
diff changeset
79 self.rlock = lock.LazyReadLock(self.lock_dir, 60.0)
238c43cb8877 lock: LazyReadLock, LazyWriteLock == do nothing. Only for POSIX OS and POSIX style of code using that kind of locks (see comments there).
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1307
diff changeset
80 self.wlock = lock.LazyWriteLock(self.lock_dir, 60.0)
931
141083b64fb1 whitespace and minor style changes only
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 902
diff changeset
81
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
82 # used by file-like api:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
83 self._lock = None # either self.rlock or self.wlock
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
84 self._fileobj = None # open cache file object
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
85 self._tmp_fname = None # name of temporary file (used for write)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
86 self._mode = None # mode of open file object
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
87
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
88
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
89 def _filename(self):
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
90 # DEPRECATED - please use file-like api
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
91 return self._fname
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
92
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
93 def exists(self):
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
94 return os.path.exists(self._fname)
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
95
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
96 def mtime(self):
3610
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
97 # DEPRECATED for checking a changed on-disk cache, please use
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
98 # self.uid() for this, see below
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
99 try:
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
100 return os.path.getmtime(self._fname)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
101 except (IOError, OSError):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
102 return 0
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
103
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
104 def size(self):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
105 try:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
106 return os.path.getsize(self._fname)
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
107 except (IOError, OSError):
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
108 return 0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
109
3610
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
110 def uid(self):
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
111 """ Return a value that likely changes when the on-disk cache was updated.
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
112
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
113 See docstring of MoinMoin.util.filesys.fuid for details.
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
114 """
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
115 return filesys.fuid(self._fname)
3610
39456a5dc4e8 fix failure of detection of on-disk cache updates (this fixes unreliable dicts/groups tests), remove unused Page attribute
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3127
diff changeset
116
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
117 def needsUpdate(self, filename, attachdir=None):
1681
fc03cd8ff0f3 avoid accessing invalid page revisions, tune caching code (ported from 1.5)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1647
diff changeset
118 # following code is not necessary. will trigger exception and give same result
fc03cd8ff0f3 avoid accessing invalid page revisions, tune caching code (ported from 1.5)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1647
diff changeset
119 #if not self.exists():
fc03cd8ff0f3 avoid accessing invalid page revisions, tune caching code (ported from 1.5)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1647
diff changeset
120 # return 1
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
121
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
122 try:
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
123 ctime = os.path.getmtime(self._fname)
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
124 ftime = os.path.getmtime(filename)
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
125 except os.error:
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
126 return 1
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
127
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
128 needsupdate = ftime > ctime
931
141083b64fb1 whitespace and minor style changes only
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 902
diff changeset
129
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
130 # if a page depends on the attachment dir, we check this, too:
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
131 if not needsupdate and attachdir:
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
132 try:
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
133 ftime2 = os.path.getmtime(attachdir)
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
134 except os.error:
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
135 ftime2 = 0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
136 needsupdate = ftime2 > ctime
931
141083b64fb1 whitespace and minor style changes only
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 902
diff changeset
137
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
138 return needsupdate
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
139
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
140 def _determine_locktype(self, mode):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
141 """ return the correct lock object for a specific file access mode """
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
142 if self.locking:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
143 if 'r' in mode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
144 lock = self.rlock
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
145 if 'w' in mode or 'a' in mode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
146 lock = self.wlock
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
147 else:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
148 lock = None
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
149 return lock
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
150
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
151 # file-like interface ----------------------------------------------------
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
152
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
153 def open(self, filename=None, mode='r', bufsize=-1):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
154 """ open the cache for reading/writing
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
155
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
156 @param filename: must be None (default - automatically determine filename)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
157 @param mode: 'r' (read, default), 'w' (write)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
158 Note: if mode does not include 'b' (binary), it will be
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
159 automatically changed to include 'b'.
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
160 @param bufsize: size of read/write buffer (default: -1 meaning automatic)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
161 @return: None (the opened file object is kept in self._fileobj and used
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
162 implicitely by read/write/close functions of CacheEntry object.
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
163 """
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
164 assert self._fileobj is None, 'caching: trying to open an already opened cache'
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
165 assert filename is None, 'caching: giving a filename is not supported (yet?)'
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
166
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
167 self._lock = self._determine_locktype(mode)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
168
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
169 if 'b' not in mode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
170 mode += 'b' # we want to use binary mode, ever!
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
171 self._mode = mode # for self.close()
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
172
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
173 if not self.locking or self.locking and self._lock.acquire(1.0):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
174 try:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
175 if 'r' in mode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
176 self._fileobj = open(self._fname, mode, bufsize)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
177 elif 'w' in mode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
178 # we do not write content to old inode, but to a new file
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
179 # so we don't need to lock when we just want to read the file
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
180 # (at least on POSIX, this works)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
181 fd, self._tmp_fname = tempfile.mkstemp('.tmp', self.key, self.arena_dir)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
182 self._fileobj = os.fdopen(fd, mode, bufsize)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
183 else:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
184 raise ValueError("caching: mode does not contain 'r' or 'w'")
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
185 finally:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
186 if self.locking:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
187 self._lock.release()
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
188 self._lock = None
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
189 else:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
190 logging.error("Can't acquire read/write lock in %s" % self.lock_dir)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
191
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
192
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
193 def read(self, size=-1):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
194 """ read data from cache file
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
195
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
196 @param size: how many bytes to read (default: -1 == everything)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
197 @return: read data (str)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
198 """
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
199 return self._fileobj.read(size)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
200
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
201 def write(self, data):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
202 """ write data to cache file
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
203
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
204 @param data: write data (str)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
205 """
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
206 self._fileobj.write(data)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
207
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
208 def close(self):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
209 """ close cache file (and release lock, if any) """
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
210 if self._fileobj:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
211 self._fileobj.close()
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
212 self._fileobj = None
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
213 if 'w' in self._mode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
214 filesys.chmod(self._tmp_fname, 0666 & config.umask) # fix mode that mkstemp chose
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
215 # this is either atomic or happening with real locks set:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
216 filesys.rename(self._tmp_fname, self._fname)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
217
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
218 if self._lock:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
219 if self.locking:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
220 self._lock.release()
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
221 self._lock = None
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
222
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
223 # ------------------------------------------------------------------------
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
224
1638
5070d0358544 caching: move use_pickle to __init__, remove unused encode/decode args from .content()/.update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1637
diff changeset
225 def update(self, content):
1637
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
226 try:
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
227 if hasattr(content, 'read'):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
228 # content is file-like
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
229 assert not (self.use_pickle or self.use_encode), 'caching: use_pickle and use_encode not supported with file-like api'
1637
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
230 try:
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
231 self.open(mode='w')
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
232 shutil.copyfileobj(content, self)
1637
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
233 finally:
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
234 self.close()
1637
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
235 else:
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
236 # content is a string
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
237 if self.use_pickle:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
238 content = pickle.dumps(content, PICKLE_PROTOCOL)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
239 elif self.use_encode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
240 content = content.encode(config.charset)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
241
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
242 try:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
243 self.open(mode='w')
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
244 self.write(content)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
245 finally:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
246 self.close()
2841
93be75db2051 handle out-of-space errors in PageEditor and caching, avoid 'current' corruption (thanks to TheAnarcat)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2238
diff changeset
247 except (pickle.PicklingError, OSError, IOError, ValueError), err:
1637
47a173ae5401 caching module: use_pickle argument for .content() and .update()
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 1429
diff changeset
248 raise CacheError(str(err))
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
249
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
250 def content(self):
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
251 # no file-like api yet, we implement it when we need it
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
252 try:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
253 try:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
254 self.open(mode='r')
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
255 data = self.read()
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
256 finally:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
257 self.close()
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
258 if self.use_pickle:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
259 data = pickle.loads(data)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
260 elif self.use_encode:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
261 data = data.decode(config.charset)
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
262 return data
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
263 except (pickle.UnpicklingError, IOError, EOFError, ValueError), err:
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
264 raise CacheError(str(err))
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
265
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
266 def remove(self):
1307
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
267 if not self.locking or self.locking and self.wlock.acquire(1.0):
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
268 try:
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
269 try:
3878
b13a58a18dac caching module backported from 1.8 (file-like new api, old api still as is)
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 3610
diff changeset
270 os.remove(self._fname)
1307
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
271 except OSError:
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
272 pass
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
273 finally:
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
274 if self.locking:
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
275 self.wlock.release()
6bc162aba29d caching: update contents by tmpfile+rename, not touching old inode content. add locking for .remove() call. small fixes to lock code.
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 931
diff changeset
276 else:
3127
ea5383222f2f refactored misc. modules to use own logger instead of request.log
Thomas Waldmann <tw AT waldmann-edv DOT de>
parents: 2841
diff changeset
277 logging.error("Can't acquire write lock in %s" % self.lock_dir)
0
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
278
77665d8e2254 tag of nonpublic@localhost--archive/moin--enterprise--1.5--base-0
Thomas Waldmann <tw-public@gmx.de>
parents:
diff changeset
279