public
Description: A simple python based wiki
Homepage: http://www.neohippie.net/
Clone URL: git://github.com/synack/nikiwiki.git
nikiwiki / nstore.py
100644 428 lines (388 sloc) 12.528 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
from base64 import b64encode, b64decode
from threading import Thread
from random import choice
from time import strftime
import os, os.path
import cPickle
import zlib
 
from wsgiref.simple_server import make_server
from httplib import HTTPConnection
from cgi import parse_qs
import urllib, urlparse
 
class DictMixin(object):
"""
Superclass for implementing data sources
"""
def keys(self): pass
def __getitem__(self, key): pass
def __setitem__(self, key, value): pass
def __delitem__(self, key): pass
 
class UserDict(object):
"""
Superclass for implementing data transforms
"""
def __init__(self, data):
self.data = data
def __getitem__(self, key):
return self.data[key]
def __setitem__(self, key, value):
self.data[key] = value
def __delitem__(self, key):
del self.data[key]
def keys(self):
return self.data.keys()
 
class FileStore(DictMixin):
"""
Implements file-backed storage. Automatically creates/removes subdirectories
when a key contains the / character. Normal path syntax is allowed within
keys. For example: data['my/data/here/../data'] is equivalent to
data['my/data/data']. You cannot escape beyond the root of the file store.
"""
def __init__(self, path):
self.path = path
 
def keys(self):
for dirpath, dirnames, filenames in os.walk(self.path):
for name in filenames:
yield os.path.join(dirpath.split(self.path, 1)[1], name)
 
def get_path(self, key):
path = os.path.normpath(os.path.join(self.path, key))
if not path.startswith(self.path):
raise KeyError
else:
return path
 
def __getitem__(self, key):
path = self.get_path(key)
if not os.path.exists(path):
raise KeyError(key)
if os.path.isdir(path):
raise KeyError(key)
return open(path, 'r').read()
 
def __setitem__(self, key, value):
path = self.get_path(key)
if os.path.isdir(path):
raise KeyError
spath = '/'.join(path.split('/')[:-1])
if not os.path.exists(spath):
os.makedirs(spath)
fd = open(path, 'w')
fd.write(value)
fd.close()
 
def __delitem__(self, key):
path = self.get_path(key)
if os.path.isdir(path):
os.removedirs(path)
else:
os.remove(path)
basepath = '/'.join(path.split('/')[:-1])
if len(os.listdir(basepath)) == 0:
os.rmdir(basepath)
 
class MemoryStore(DictMixin):
"""
A simple storage mechanism that just wraps Python's builtin dict object.
This class isn't really necessary, but exists for the sake of consistency.
"""
def __init__(self):
self.data = {}
def __getitem__(self, key):
return self.data[key]
def __setitem__(self, key, value):
self.data[key] = value
def __delitem__(self, key):
del self.data[key]
def keys(self):
return self.data.keys()
 
class PickleSerializer(UserDict):
"""
Serializes python objects into a data store. When using this module, the
data returned from the serializer usually needs to be referenced by another
name before it can be modified. For example:
>>> data['foo'] = ['bar', 'baz']
>>> data['foo'][1] = 'foo'
Will throw an exception. Instead, try:
>>> foolist = data['foo']
>>> foolist[1] = 'foo'
>>> data['foo'] = foolist
"""
def __init__(self, data):
self.data = data
def __getitem__(self, key):
return cPickle.loads(self.data[key])
def __setitem__(self, key, value):
self.data[key] = cPickle.dumps(value)
def __delitem__(self, key):
del self.data[key]
 
class B64KeyDict(UserDict):
"""
Converts all keys to base64 strings. This should be used when a backend
storage module doesn't support binary data in the keys (assuming you need to
use binary keys)
"""
def __getitem__(self, key):
return self.data[b64encode(key)]
def __setitem__(self, key, value):
self.data[b64encode(key)] = value
def __delitem__(self, key):
del self.data[b64encode(key)]
def keys(self):
return [b64decode(x) for x in self.data.keys()]
 
class VersionedDict(UserDict):
def __getitem__(self, key):
try:
key, rev = key.rsplit('@', 1)
rev = int(rev)
except:
rev = int(self.data['%s/latest' % key])
return self.data['%s/%i' % (key, rev)]
def __setitem__(self, key, value):
try:
rev = int(self.data['%s/latest' % key])
rev += 1
except KeyError:
rev = 0
self.data['%s/%i' % (key, rev)] = value
self.data['%s/latest' % key] = str(rev)
 
try:
revisions = self.data['%s/revisions' % key]
revisions = cPickle.loads(revisions)
except KeyError:
revisions = []
revisions.append(rev)
self.data['%s/revisions' % key] = cPickle.dumps(revisions)
def __delitem__(self, key):
revisions = cPickle.loads(self.data['%s/revisions' % key])
for rev in revisions:
del self.data['%s/%i' % (key, rev)]
del self.data['%s/latest' % key]
del self.data['%s/revisions' % key]
del self.data[key]
 
class PrefixDict(UserDict):
def __init__(self, data, prefix):
self.data = data
self.prefix = prefix
def __getitem__(self, key):
return self.data[self.prefix + key]
def __setitem__(self, key, value):
self.data[self.prefix + key] = value
def __delitem__(self, key):
del self.data[self.prefix + key]
def keys(self):
return [k[len(self.prefix):] for k in self.data.keys() if k.startswith(self.prefix)]
 
class LoggingDict(UserDict):
"""
Writes out a simple message to logfd whenever the dict is accessed or
changed. Useful for debugging.
"""
def __init__(self, data, logfd=None, date_format='%m/%d/%Y %H:%M:%S %Z'):
self.data = data
self.fd = logfd
self.date_format = date_format
 
def __getitem__(self, key):
self.fd.write('%s GET %s\n' % (strftime(self.date_format), key))
return self.data[key]
 
def __setitem__(self, key, value):
self.fd.write('%s SET %s\n' % (strftime(self.date_format), key))
self.data[key] = value
 
def __delitem__(self, key):
self.fd.write('%s DEL %s\n' % (strftime(self.date_format), key))
del self.data[key]
 
class CacheDict(UserDict):
"""
Implements a simple caching mechanism between two backend storage systems.
The data argument is the primary, authoratative data store. caches is a list
of data stores to be used for caching data.
The sync_write argument should be set to True if the __setitem__ method
should block until all caches are updated. Otherwise, it will only block
until the primary data store is updated.
"""
def __init__(self, data, caches=[], sync_write=False):
self.data = data
self.caches = caches
self.sync_write = sync_write
 
def __setitem__(self, key, value):
self.data[key] = value
threads = []
for cache in self.caches:
t = Thread(target=cache.__setitem__, args=(key, value))
threads.append(t)
t.start()
 
if self.sync_write:
for t in threads:
t.join()
 
def __getitem__(self, key):
try:
cache = choice(self.caches)
return cache[key]
except KeyError:
value = self.data[key]
cache[key] = value
return value
 
def __delitem__(self, key):
del self.data[key]
threads = []
for cache in self.caches:
t = Thread(target=cache.__delitem__, args=(key))
threads.append(t)
t.start()
 
if self.sync_write:
for t in threads:
t.join()
 
def keys(self):
return self.data.keys()
 
class ZipDict(UserDict):
"""
Compresses the values in the data store using the Python builtin zlib module
"""
def __getitem__(self, key):
return zlib.decompress(self.data[key])
def __setitem__(self, key, value):
self.data[key] = zlib.compress(value)
 
class HTTPStore(DictMixin):
"""
Implements a storage backend over HTTP. This class acts as an HTTP client
for connecting to a RESTful storage server. The server needs to respond with
the of a given key for the GET request and an error or 200 OK message for a
POST or DELETE request. The remote server should also return a newline
delimited list of keys when the base URI is requested.
"""
def __init__(self, uri):
self.uri = uri
 
def __getitem__(self, key):
target = urlparse.urlparse(self.uri)
if target.netloc.find(':') != -1:
server, port = target.netloc.split(':', 1)
else:
server = target.netloc
port = 80
conn = HTTPConnection(server, int(port))
conn.request('GET', '/%s' % urllib.quote(key))
response = conn.getresponse()
if response.status == 404:
raise KeyError(key)
if response.status != 200:
raise IOError(response.status)
chunk = True
data = ''
while chunk != '':
chunk = response.read()
data += chunk
return data
 
def __setitem__(self, key, value):
target = urlparse.urljoin(self.uri, urllib.quote(key))
response = urllib.urlopen(target, urllib.urlencode({'value': value}))
result = response.read()
 
def __delitem__(self, key):
target = urlparse.urlparse(self.uri)
if target.netloc.find(':') != -1:
server, port = target.netloc.split(':', 1)
else:
server = target.netloc
port = 80
conn = HTTPConnection(server, int(port))
conn.request('DELETE', '/%s' % urllib.quote(key))
response = conn.getresponse()
if response.status == 404:
raise KeyError(key)
if response.status != 200:
raise IOError('%s %s' % (response.status, response.reason))
 
def keys(self):
return self.__getitem__('').split('\n')
 
class HTTPDict(UserDict):
"""
Implements a server for the HTTPStore class. When initialized, the server
will spawn a separate thread to handle requests. A simple WSGI application
performs the actual application logic.
"""
def __init__(self, data, port=9608):
self.data = data
self.server = make_server('', port, self.wsgiapp)
t = Thread(target=self.server.serve_forever)
t.setDaemon(True)
t.start()
 
def wsgiapp(self, environ, start_response):
key = urllib.unquote(environ['PATH_INFO']).lstrip('/')
if environ['REQUEST_METHOD'] == 'GET':
try:
if key == '':
response = [x + '\n' for x in self.data.keys()]
response[-1] = response[-1].rstrip('\n')
else:
response = [self.data[key]]
except KeyError:
start_response('404 Not Found', [('Content-type', 'text/plain')])
return ['']
start_response('200 OK', [('Content-type', 'application/octet-stream')])
return response
 
if environ['REQUEST_METHOD'] == 'POST':
query = environ['wsgi.input'].read(int(environ['CONTENT_LENGTH']))
query = parse_qs(query)
if 'value' in query:
value = query['value'][0]
self.data[key] = value
start_response('200 OK', [('Content-type', 'text/plain')])
return [str(len(value))]
else:
start_response('400 Bad Request', [('Content-type', 'text/plain')])
return ['']
if environ['REQUEST_METHOD'] == 'DELETE':
del self.data[key]
start_response('200 OK', [('Content-type', 'text/plain')])
return ['']
 
try:
import google.appengine.api.urlfetch
from google.appengine.ext import db
class AppEngineData(db.Model):
name = db.StringProperty(required=True)
value = db.BlobProperty(required=True)
class AppEngineStore(DictMixin):
def __getitem__(self, key):
result = db.GqlQuery('SELECT * FROM AppEngineData WHERE name = :1', key).fetch(1)
if len(result) > 1:
return result[1]
else:
raise KeyError(key)
def __setitem__(self, key, value):
data = AppEngineData(name=key, value=value)
data.put()
def __delitem__(self, key):
db.GqlQuery('DELETE FROM AppEngineData WHERE name = :1', key)
def keys(self):
return db.GqlQuery("SELECT name FROM AppEngineData")
class GoogleHTTPStore(DictMixin):
def __init__(self, url):
self.url = url
def __getitem__(self, key):
response = google.appengine.api.urlfetch.fetch(self.url + key, method=google.appengine.api.urlfetch.GET)
if response.status_code == 200:
return response.content
else:
raise KeyError(key)
def __setitem__(self, key, value):
response = google.appengine.api.urlfetch.fetch(self.url + key, method=google.appengine.api.urlfetch.POST, payload=value)
if response.status_code != 200:
raise IOError('%s %s' % (response.status_code, response.content))
def __delitem__(self, key):
response = google.appengine.api.urlfetch.fetch(self.url + key, method=google.appengine.api.urlfetch.DELETE)
if response.status_code != 200:
raise KeyError(key)
def keys(self):
return self.__getitem__('').split('\n')
except ImportError: pass
 
def basic_test(data):
data['test'] = 'foo'
assert data['test'] == 'foo'
data['test1/test2'] = 'test3'
assert data['test1/test2'] == 'test3'
#del data['test']
#del data['test1/test2']
 
def test():
data = FileStore('/tmp/nstore_test')
basic_test(data)
print 'FileStore'
data = VersionedDict(data)
basic_test(data)
print 'FileStore/VersionedDict'
data = B64KeyDict(data)
basic_test(data)
print 'FileStore/VersionedDict/B64KeyDict'
 
if __name__ == "__main__":
test()