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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
|
#!/usr/bin/env python
#
# Copyright 2007 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Simple datastore view and interactive console, for use in dev_appserver."""
import cgi
import csv
import cStringIO
import datetime
import logging
import math
import mimetypes
import os
import os.path
import pickle
import pprint
import random
import sys
import time
import traceback
import types
import urllib
import urlparse
import wsgiref.handlers
try:
from google.appengine.cron import groctimespecification
from google.appengine.api import croninfo
except ImportError:
HAVE_CRON = False
else:
HAVE_CRON = True
from google.appengine.api import apiproxy_stub_map
from google.appengine.api import datastore
from google.appengine.api import datastore_admin
from google.appengine.api import datastore_types
from google.appengine.api import datastore_errors
from google.appengine.api import memcache
from google.appengine.api.labs import taskqueue
from google.appengine.api import users
from google.appengine.ext import db
from google.appengine.ext import webapp
from google.appengine.ext.webapp import template
_DEBUG = True
def ustr(value):
"""Like str(), but UTF-8-encodes Unicode instead of failing."""
try:
return str(value)
except UnicodeError:
return unicode(value).encode('UTF-8')
class ImageHandler(webapp.RequestHandler):
"""Serves a static image.
This exists because we don't want to burden the user with specifying
a static file handler for the image resources used by the admin tool.
"""
PATH = '/images/.*'
def get(self):
image_name = os.path.basename(self.request.path)
content_type, encoding = mimetypes.guess_type(image_name)
if not content_type or not content_type.startswith('image/'):
logging.debug('image_name=%r, content_type=%r, encoding=%r',
image_name, content_type, encoding)
self.error(404)
return
directory = os.path.dirname(__file__)
path = os.path.join(directory, 'templates', 'images', image_name)
try:
image_stream = open(path, 'rb')
except IOError, e:
logging.error('Cannot open image %s: %s', image_name, e)
self.error(404)
return
try:
image_data = image_stream.read()
finally:
image_stream.close()
self.response.headers['Content-Type'] = content_type
self.response.out.write(image_data)
class BaseRequestHandler(webapp.RequestHandler):
"""Supplies a common template generation function.
When you call generate(), we augment the template variables supplied with
the current user in the 'user' variable and the current webapp request
in the 'request' variable.
"""
def generate(self, template_name, template_values={}):
base_path = self.base_path()
values = {
'application_name': self.request.environ['APPLICATION_ID'],
'user': users.get_current_user(),
'request': self.request,
'home_path': base_path + DefaultPageHandler.PATH,
'datastore_path': base_path + DatastoreQueryHandler.PATH,
'datastore_edit_path': base_path + DatastoreEditHandler.PATH,
'datastore_batch_edit_path': base_path + DatastoreBatchEditHandler.PATH,
'interactive_path': base_path + InteractivePageHandler.PATH,
'interactive_execute_path': base_path + InteractiveExecuteHandler.PATH,
'memcache_path': base_path + MemcachePageHandler.PATH,
'queues_path': base_path + QueuesPageHandler.PATH,
'xmpp_path': base_path + XMPPPageHandler.PATH,
'inboundmail_path': base_path + InboundMailPageHandler.PATH,
}
if HAVE_CRON:
values['cron_path'] = base_path + CronPageHandler.PATH
values.update(template_values)
directory = os.path.dirname(__file__)
path = os.path.join(directory, os.path.join('templates', template_name))
self.response.out.write(template.render(path, values, debug=_DEBUG))
def base_path(self):
"""Returns the base path of this admin app, which is chosen by the user.
The user specifies which paths map to this application in their app.cfg.
You can get that base path with this method. Combine with the constant
paths specified by the classes to construct URLs.
"""
path = self.__class__.PATH
return self.request.path[:-len(path)]
def filter_url(self, args):
"""Filters the current URL to only have the given list of arguments.
For example, if your URL is /search?q=foo&num=100&start=10, then
self.filter_url(['start', 'num']) => /search?num=100&start=10
self.filter_url(['q']) => /search?q=10
self.filter_url(['random']) => /search?
"""
queries = []
for arg in args:
value = self.request.get(arg)
if value:
queries.append(arg + '=' + urllib.quote_plus(self.request.get(arg)))
return self.request.path + '?' + '&'.join(queries)
def in_production(self):
"""Detects if app is running in production.
Returns a boolean.
"""
server_software = os.environ['SERVER_SOFTWARE']
return not server_software.startswith('Development')
class DefaultPageHandler(BaseRequestHandler):
"""Redirects to the Datastore application by default."""
PATH = '/'
def get(self):
if self.request.path.endswith('/'):
base = self.request.path[:-1]
else:
base = self.request.path
self.redirect(base + DatastoreQueryHandler.PATH)
class InteractivePageHandler(BaseRequestHandler):
"""Shows our interactive console HTML."""
PATH = '/interactive'
def get(self):
self.generate('interactive.html')
class InteractiveExecuteHandler(BaseRequestHandler):
"""Executes the Python code submitted in a POST within this context.
For obvious reasons, this should only be available to administrators
of the applications.
"""
PATH = InteractivePageHandler.PATH + '/execute'
def post(self):
save_stdout = sys.stdout
results_io = cStringIO.StringIO()
try:
sys.stdout = results_io
code = self.request.get('code')
code = code.replace("\r\n", "\n")
try:
compiled_code = compile(code, '<string>', 'exec')
exec(compiled_code, globals())
except Exception, e:
traceback.print_exc(file=results_io)
finally:
sys.stdout = save_stdout
results = results_io.getvalue()
self.generate('interactive-output.html', {'output': results})
class CronPageHandler(BaseRequestHandler):
"""Shows information about configured cron jobs in this application."""
PATH = '/cron'
def get(self, now=None):
"""Shows template displaying the configured cron jobs."""
if not now:
now = datetime.datetime.now()
values = {'request': self.request}
cron_info = _ParseCronYaml()
values['cronjobs'] = []
values['now'] = str(now)
if cron_info and cron_info.cron:
for entry in cron_info.cron:
job = {}
values['cronjobs'].append(job)
if entry.description:
job['description'] = entry.description
else:
job['description'] = '(no description)'
if entry.timezone:
job['timezone'] = entry.timezone
job['url'] = entry.url
job['schedule'] = entry.schedule
schedule = groctimespecification.GrocTimeSpecification(entry.schedule)
matches = schedule.GetMatches(now, 3)
job['times'] = []
for match in matches:
job['times'].append({'runtime': match.strftime("%Y-%m-%d %H:%M:%SZ"),
'difference': str(match - now)})
self.generate('cron.html', values)
class XMPPPageHandler(BaseRequestHandler):
"""Tests XMPP requests."""
PATH = '/xmpp'
def get(self):
"""Shows template displaying the XMPP."""
xmpp_configured = True
values = {
'xmpp_configured': xmpp_configured,
'request': self.request
}
self.generate('xmpp.html', values)
class InboundMailPageHandler(BaseRequestHandler):
"""Tests Mail requests."""
PATH = '/inboundmail'
def get(self):
"""Shows template displaying the Inbound Mail form."""
inboundmail_configured = True
values = {
'inboundmail_configured': inboundmail_configured,
'request': self.request
}
self.generate('inboundmail.html', values)
class QueuesPageHandler(BaseRequestHandler):
"""Shows information about configured (and default) task queues."""
PATH = '/queues'
def __init__(self):
self.stub = apiproxy_stub_map.apiproxy.GetStub('taskqueue')
def get(self):
"""Shows template displaying the configured task queues."""
values = {
'request': self.request,
'queues': self.stub.GetQueues(),
}
self.generate('queues.html', values)
def post(self):
"""Handle modifying actions and/or redirect to GET page."""
if self.request.get('action:flushqueue'):
self.stub.FlushQueue(self.request.get('queue'))
self.redirect(self.request.path_url)
class TasksPageHandler(BaseRequestHandler):
"""Shows information about a queue's tasks."""
PATH = '/tasks'
PAGE_SIZE = 20
def __init__(self):
self.stub = apiproxy_stub_map.apiproxy.GetStub('taskqueue')
def get(self):
"""Shows template displaying the queue's tasks."""
queue = self.request.get('queue')
start = int(self.request.get('start', 0))
all_tasks = self.stub.GetTasks(queue)
next_start = start + self.PAGE_SIZE
tasks = all_tasks[start:next_start]
current_page = int(start / self.PAGE_SIZE) + 1
pages = []
for number in xrange(int(math.ceil(len(all_tasks) /
float(self.PAGE_SIZE)))):
pages.append({
'number': number + 1,
'start': number * self.PAGE_SIZE
})
if not all_tasks[next_start:]:
next_start = -1
prev_start = start - self.PAGE_SIZE
if prev_start < 0:
prev_start = -1
values = {
'request': self.request,
'queue_name': queue,
'tasks': tasks,
'start_base_url': self.filter_url(['queue']),
'prev_start': prev_start,
'next_start': next_start,
'pages': pages,
'current_page': current_page,
}
self.generate('tasks.html', values)
def post(self):
if self.request.get('action:deletetask'):
self.stub.DeleteTask(self.request.get('queue'), self.request.get('task'))
self.redirect(self.request.path_url + '?queue=' + self.request.get('queue'))
return
class MemcachePageHandler(BaseRequestHandler):
"""Shows stats about memcache and query form to get values."""
PATH = '/memcache'
TYPES = ((str, str, 'String'),
(unicode, unicode, 'Unicode String'),
(bool, lambda value: MemcachePageHandler._ToBool(value), 'Boolean'),
(int, int, 'Integer'),
(long, long, 'Long Integer'),
(float, float, 'Float'))
DEFAULT_TYPESTR_FOR_NEW = 'String'
@staticmethod
def _ToBool(string_value):
"""Convert string to boolean value.
Args:
string_value: A string.
Returns:
Boolean. True if string_value is "true", False if string_value is
"false". This is case-insensitive.
Raises:
ValueError: string_value not "true" or "false".
"""
string_value_low = string_value.lower()
if string_value_low not in ('false', 'true'):
raise ValueError('invalid literal for boolean: %s' % string_value)
return string_value_low == 'true'
def _GetValueAndType(self, key):
"""Fetch value from memcache and detect its type.
Args:
key: String
Returns:
(value, type), value is a Python object or None if the key was not set in
the cache, type is a string describing the type of the value.
"""
try:
value = memcache.get(key)
except (pickle.UnpicklingError, AttributeError, EOFError, ImportError,
IndexError), e:
msg = 'Failed to retrieve value from cache: %s' % e
return msg, 'error'
if value is None:
return None, self.DEFAULT_TYPESTR_FOR_NEW
for typeobj, _, typestr in self.TYPES:
if isinstance(value, typeobj):
break
else:
typestr = 'pickled'
value = pprint.pformat(value, indent=2)
return value, typestr
def _SetValue(self, key, type_, value):
"""Convert a string value and store the result in memcache.
Args:
key: String
type_: String, describing what type the value should have in the cache.
value: String, will be converted according to type_.
Returns:
Result of memcache.set(ket, converted_value). True if value was set.
Raises:
ValueError: Value can't be converted according to type_.
"""
for _, converter, typestr in self.TYPES:
if typestr == type_:
value = converter(value)
break
else:
raise ValueError('Type %s not supported.' % type_)
return memcache.set(key, value)
def get(self):
"""Show template and prepare stats and/or key+value to display/edit."""
values = {'request': self.request,
'message': self.request.get('message')}
edit = self.request.get('edit')
key = self.request.get('key')
if edit:
key = edit
values['show_stats'] = False
values['show_value'] = False
values['show_valueform'] = True
values['types'] = [typestr for _, _, typestr in self.TYPES]
elif key:
values['show_stats'] = True
values['show_value'] = True
values['show_valueform'] = False
else:
values['show_stats'] = True
values['show_valueform'] = False
values['show_value'] = False
if key:
values['key'] = key
values['value'], values['type'] = self._GetValueAndType(key)
values['key_exists'] = values['value'] is not None
if values['type'] in ('pickled', 'error'):
values['writable'] = False
else:
values['writable'] = True
if values['show_stats']:
memcache_stats = memcache.get_stats()
if not memcache_stats:
memcache_stats = {'hits': 0, 'misses': 0, 'byte_hits': 0, 'items': 0,
'bytes': 0, 'oldest_item_age': 0}
values['stats'] = memcache_stats
try:
hitratio = memcache_stats['hits'] * 100 / (memcache_stats['hits']
+ memcache_stats['misses'])
except ZeroDivisionError:
hitratio = 0
values['hitratio'] = hitratio
delta_t = datetime.timedelta(seconds=memcache_stats['oldest_item_age'])
values['oldest_item_age'] = datetime.datetime.now() - delta_t
self.generate('memcache.html', values)
def _urlencode(self, query):
"""Encode a dictionary into a URL query string.
In contrast to urllib this encodes unicode characters as UTF8.
Args:
query: Dictionary of key/value pairs.
Returns:
String.
"""
return '&'.join('%s=%s' % (urllib.quote_plus(k.encode('utf8')),
urllib.quote_plus(v.encode('utf8')))
for k, v in query.iteritems())
def post(self):
"""Handle modifying actions and/or redirect to GET page."""
next_param = {}
if self.request.get('action:flush'):
if memcache.flush_all():
next_param['message'] = 'Cache flushed, all keys dropped.'
else:
next_param['message'] = 'Flushing the cache failed. Please try again.'
elif self.request.get('action:display'):
next_param['key'] = self.request.get('key')
elif self.request.get('action:edit'):
next_param['edit'] = self.request.get('key')
elif self.request.get('action:delete'):
key = self.request.get('key')
result = memcache.delete(key)
if result == memcache.DELETE_NETWORK_FAILURE:
next_param['message'] = ('ERROR: Network failure, key "%s" not deleted.'
% key)
elif result == memcache.DELETE_ITEM_MISSING:
next_param['message'] = 'Key "%s" not in cache.' % key
elif result == memcache.DELETE_SUCCESSFUL:
next_param['message'] = 'Key "%s" deleted.' % key
else:
next_param['message'] = ('Unknown return value. Key "%s" might still '
'exist.' % key)
elif self.request.get('action:save'):
key = self.request.get('key')
value = self.request.get('value')
type_ = self.request.get('type')
next_param['key'] = key
try:
if self._SetValue(key, type_, value):
next_param['message'] = 'Key "%s" saved.' % key
else:
next_param['message'] = 'ERROR: Failed to save key "%s".' % key
except ValueError, e:
next_param['message'] = 'ERROR: Unable to encode value: %s' % e
elif self.request.get('action:cancel'):
next_param['key'] = self.request.get('key')
else:
next_param['message'] = 'Unknown action.'
next = self.request.path_url
if next_param:
next = '%s?%s' % (next, self._urlencode(next_param))
self.redirect(next)
class DatastoreRequestHandler(BaseRequestHandler):
"""The base request handler for our datastore admin pages.
We provide utility functions for quering the datastore and infering the
types of entity properties.
"""
def start(self):
"""Returns the santized "start" argument from the URL."""
return self.request.get_range('start', min_value=0, default=0)
def num(self):
"""Returns the sanitized "num" argument from the URL."""
return self.request.get_range('num', min_value=1, max_value=100,
default=10)
def execute_query(self, start=0, num=0, no_order=False):
"""Parses the URL arguments and executes the query.
We return a tuple (list of entities, total entity count).
If the appropriate URL arguments are not given, we return an empty
set of results and 0 for the entity count.
"""
kind = self.request.get('kind')
namespace = self.request.get('namespace')
if not namespace:
namespace = None
if not kind:
return ([], 0)
query = datastore.Query(kind, _namespace=namespace)
order = self.request.get('order')
order_type = self.request.get('order_type')
if order and order_type:
order_type = DataType.get_by_name(order_type).python_type()
if order.startswith('-'):
direction = datastore.Query.DESCENDING
order = order[1:]
else:
direction = datastore.Query.ASCENDING
try:
query.Order((order, order_type, direction))
except datastore_errors.BadArgumentError:
pass
if not start:
start = self.start()
if not num:
num = self.num()
total = query.Count()
entities = query.Get(start + num)[start:]
return (entities, total)
def get_key_values(self, entities):
"""Returns the union of key names used by the given list of entities.
We return the union as a dictionary mapping the key names to a sample
value from one of the entities for the key name.
"""
key_dict = {}
for entity in entities:
for key, value in entity.iteritems():
if key_dict.has_key(key):
key_dict[key].append(value)
else:
key_dict[key] = [value]
return key_dict
class DatastoreQueryHandler(DatastoreRequestHandler):
"""Our main request handler that executes queries and lists entities.
We use execute_query() in our base request handler to parse URL arguments
and execute the datastore query.
"""
PATH = '/datastore'
def get_kinds(self):
"""Get sorted list of kind names the datastore knows about.
This should only be called in the development environment as GetSchema is
expensive and no caching is done.
"""
schema = datastore_admin.GetSchema()
kinds = []
for entity_proto in schema:
kinds.append(entity_proto.key().path().element_list()[-1].type())
kinds.sort()
return kinds
def get(self):
"""Formats the results from execute_query() for datastore.html.
The only complex part of that process is calculating the pager variables
to generate the Gooooogle pager at the bottom of the page.
"""
result_set, total = self.execute_query()
key_values = self.get_key_values(result_set)
keys = key_values.keys()
keys.sort()
headers = []
for key in keys:
sample_value = key_values[key][0]
headers.append({
'name': key,
'type': DataType.get(sample_value).name(),
})
entities = []
edit_path = self.base_path() + DatastoreEditHandler.PATH
for entity in result_set:
attributes = []
for key in keys:
if entity.has_key(key):
raw_value = entity[key]
data_type = DataType.get(raw_value)
value = data_type.format(raw_value)
short_value = data_type.short_format(raw_value)
additional_html = data_type.additional_short_value_html(raw_value)
else:
value = ''
short_value = ''
additional_html = ''
attributes.append({
'name': key,
'value': value,
'short_value': short_value,
'additional_html': additional_html,
})
entities.append({
'key': str(entity.key()),
'key_name': entity.key().name(),
'key_id': entity.key().id(),
'shortened_key': str(entity.key())[:8] + '...',
'attributes': attributes,
'edit_uri': edit_path + '?key=' + str(entity.key()) + '&kind=' + urllib.quote(self.request.get('kind')) + '&next=' + urllib.quote(self.request.uri),
})
start = self.start()
num = self.num()
max_pager_links = 8
current_page = start / num
num_pages = int(math.ceil(total * 1.0 / num))
page_start = max(math.floor(current_page - max_pager_links / 2), 0)
page_end = min(page_start + max_pager_links, num_pages)
pages = []
for page in range(page_start + 1, page_end + 1):
pages.append({
'number': page,
'start': (page - 1) * num,
})
current_page += 1
in_production = self.in_production()
if in_production:
kinds = None
else:
kinds = self.get_kinds()
values = {
'request': self.request,
'in_production': in_production,
'kinds': kinds,
'kind': self.request.get('kind'),
'order': self.request.get('order'),
'headers': headers,
'entities': entities,
'message': self.request.get('msg'),
'pages': pages,
'current_page': current_page,
'namespace': self.request.get('namespace'),
'num': num,
'next_start': -1,
'prev_start': -1,
'start': start,
'total': total,
'start_base_url': self.filter_url(['kind', 'order', 'order_type',
'num']),
'order_base_url': self.filter_url(['kind', 'num']),
}
if current_page > 1:
values['prev_start'] = int((current_page - 2) * num)
if current_page < num_pages:
values['next_start'] = int(current_page * num)
self.generate('datastore.html', values)
class DatastoreBatchEditHandler(DatastoreRequestHandler):
"""Request handler for a batch operation on entities.
Supports deleting multiple entities by key, then redirecting to another url.
"""
PATH = DatastoreQueryHandler.PATH + '/batchedit'
def post(self):
kind = self.request.get('kind')
keys = []
index = 0
num_keys = int(self.request.get('numkeys'))
for i in xrange(1, num_keys+1):
key = self.request.get('key%d' % i)
if key:
keys.append(key)
if self.request.get('action') == 'Delete':
num_deleted = 0
for key in keys:
datastore.Delete(datastore.Key(key))
num_deleted = num_deleted + 1
message = '%d entit%s deleted.' % (
num_deleted, ('ies', 'y')[num_deleted == 1])
self.redirect(
'%s&msg=%s' % (self.request.get('next'), urllib.quote_plus(message)))
return
self.error(404)
class DatastoreEditHandler(DatastoreRequestHandler):
"""Request handler for the entity create/edit form.
We determine how to generate a form to edit an entity by doing a query
on the entity kind and looking at the set of keys and their types in
the result set. We use the DataType subclasses for those introspected types
to generate the form and parse the form results.
"""
PATH = DatastoreQueryHandler.PATH + '/edit'
def get(self):
entity_key = self.request.get('key')
if entity_key:
key_instance = datastore.Key(entity_key)
entity_key_name = key_instance.name()
entity_key_id = key_instance.id()
parent_key = key_instance.parent()
kind = key_instance.kind()
entity = datastore.Get(key_instance)
sample_entities = [entity]
else:
kind = self.request.get('kind')
sample_entities = self.execute_query()[0]
if len(sample_entities) < 1:
next_uri = self.request.get('next')
kind_param = 'kind=%s' % kind
if not kind_param in next_uri:
if '?' in next_uri:
next_uri += '&' + kind_param
else:
next_uri += '?' + kind_param
self.redirect(next_uri)
return
if not entity_key:
key_instance = None
entity_key_name = None
entity_key_id = None
parent_key = None
entity = None
if parent_key:
parent_kind = parent_key.kind()
parent_key_string = PseudoBreadcrumbs(parent_key)
else:
parent_kind = None
parent_key_string = None
fields = []
key_values = self.get_key_values(sample_entities)
for key, sample_values in key_values.iteritems():
if entity and entity.has_key(key):
data_type = DataType.get(entity[key])
else:
data_type = DataType.get(sample_values[0])
name = data_type.name() + "|" + key
if entity and entity.has_key(key):
value = entity[key]
else:
value = None
field = data_type.input_field(name, value, sample_values)
fields.append((key, data_type.name(), field))
self.generate('datastore_edit.html', {
'kind': kind,
'key': entity_key,
'key_name': entity_key_name,
'key_id': entity_key_id,
'fields': fields,
'focus': self.request.get('focus'),
'namespace': self.request.get('namespace'),
'next': self.request.get('next'),
'parent_key': parent_key,
'parent_kind': parent_kind,
'parent_key_string': parent_key_string,
})
def post(self):
kind = self.request.get('kind')
entity_key = self.request.get('key')
if entity_key:
if self.request.get('action') == 'Delete':
datastore.Delete(datastore.Key(entity_key))
self.redirect(self.request.get('next'))
return
entity = datastore.Get(datastore.Key(entity_key))
else:
namespace = self.request.get('namespace')
if not namespace:
namespace = None
entity = datastore.Entity(kind, _namespace=namespace)
args = self.request.arguments()
for arg in args:
bar = arg.find('|')
if bar > 0:
data_type_name = arg[:bar]
field_name = arg[bar + 1:]
form_value = self.request.get(arg)
data_type = DataType.get_by_name(data_type_name)
if entity and entity.has_key(field_name):
old_formatted_value = data_type.format(entity[field_name])
if old_formatted_value == ustr(form_value):
continue
if len(form_value) > 0:
value = data_type.parse(form_value)
entity[field_name] = value
elif entity.has_key(field_name):
del entity[field_name]
datastore.Put(entity)
self.redirect(self.request.get('next'))
class DataType(object):
"""A DataType represents a data type in the datastore.
Each DataType subtype defines four methods:
format: returns a formatted string for a datastore value
input_field: returns a string HTML <input> element for this DataType
name: the friendly string name of this DataType
parse: parses the formatted string representation of this DataType
python_type: the canonical Python type for this datastore type
We use DataType instances to display formatted values in our result lists,
and we uses input_field/format/parse to generate forms and parse the results
from those forms to allow editing of entities.
"""
@staticmethod
def get(value):
return _DATA_TYPES[value.__class__]
@staticmethod
def get_by_name(name):
return _NAMED_DATA_TYPES[name]
def format(self, value):
return ustr(value)
def short_format(self, value):
return self.format(value)
def input_field(self, name, value, sample_values):
if value is not None:
string_value = self.format(value)
else:
string_value = ''
return '<input class="%s" name="%s" type="text" size="%d" value="%s"/>' % (cgi.escape(ustr(self.name())), cgi.escape(ustr(name)),
self.input_field_size(),
cgi.escape(string_value, True))
def input_field_size(self):
return 30
def additional_short_value_html(self, unused_value):
return ''
class StringType(DataType):
def format(self, value):
return ustr(value)
def input_field(self, name, value, sample_values):
value = ustr(value)
sample_values = [ustr(s) for s in sample_values]
multiline = False
if value:
multiline = len(value) > 255 or value.find('\n') >= 0
if not multiline:
for sample_value in sample_values:
if sample_value and (len(sample_value) > 255 or
sample_value.find('\n') >= 0):
multiline = True
break
if multiline:
if not value:
value = ''
return '<textarea name="%s" rows="5" cols="50">%s</textarea>' % (cgi.escape(name), cgi.escape(value))
else:
return DataType.input_field(self, name, value, sample_values)
def name(self):
return 'string'
def parse(self, value):
return value
def python_type(self):
return str
def input_field_size(self):
return 50
class TextType(StringType):
def name(self):
return 'Text'
def input_field(self, name, value, sample_values):
return '<textarea name="%s" rows="5" cols="50">%s</textarea>' % (cgi.escape(ustr(name)), cgi.escape(ustr(value)))
def parse(self, value):
return datastore_types.Text(value)
def python_type(self):
return datastore_types.Text
class BlobType(StringType):
def name(self):
return 'Blob'
def input_field(self, name, value, sample_values):
return '<binary>'
def format(self, value):
return '<binary>'
def python_type(self):
return datastore_types.Blob
class TimeType(DataType):
_FORMAT = '%Y-%m-%d %H:%M:%S'
def format(self, value):
return value.strftime(TimeType._FORMAT)
def name(self):
return 'datetime'
def parse(self, value):
return datetime.datetime(*(time.strptime(ustr(value),
TimeType._FORMAT)[0:6]))
def python_type(self):
return datetime.datetime
class ListType(DataType):
def format(self, value):
value_file = cStringIO.StringIO()
try:
writer = csv.writer(value_file)
writer.writerow(map(ustr, value))
return ustr(value_file.getvalue())
finally:
value_file.close()
def name(self):
return 'list'
def parse(self, value):
value_file = cStringIO.StringIO(ustr(value))
try:
reader = csv.reader(value_file)
fields = []
for field in reader.next():
if isinstance(field, str):
field = field.decode('utf-8')
fields.append(field)
return fields
finally:
value_file.close()
def python_type(self):
return list
class BoolType(DataType):
def name(self):
return 'bool'
def input_field(self, name, value, sample_values):
selected = { None: '', False: '', True: '' };
selected[value] = "selected"
return """<select class="%s" name="%s">
<option %s value=''></option>
<option %s value='0'>False</option>
<option %s value='1'>True</option></select>""" % (cgi.escape(self.name()), cgi.escape(name), selected[None],
selected[False], selected[True])
def parse(self, value):
if value.lower() is 'true':
return True
if value.lower() is 'false':
return False
return bool(int(value))
def python_type(self):
return bool
class NumberType(DataType):
def input_field_size(self):
return 10
class IntType(NumberType):
def name(self):
return 'int'
def parse(self, value):
return int(value)
def python_type(self):
return int
class LongType(NumberType):
def name(self):
return 'long'
def parse(self, value):
return long(value)
def python_type(self):
return long
class FloatType(NumberType):
def name(self):
return 'float'
def parse(self, value):
return float(value)
def python_type(self):
return float
class UserType(DataType):
def name(self):
return 'User'
def parse(self, value):
return users.User(value)
def python_type(self):
return users.User
def input_field_size(self):
return 15
class ReferenceType(DataType):
def name(self):
return 'Key'
def short_format(self, value):
return str(value)[:8] + '...'
def parse(self, value):
return datastore_types.Key(value)
def python_type(self):
return datastore_types.Key
def input_field(self, name, value, sample_values):
if value is not None:
string_value = self.format(value)
else:
string_value = ''
html = '<input class="%s" name="%s" type="text" size="%d" value="%s"/>' % (cgi.escape(self.name()), cgi.escape(name), self.input_field_size(),
cgi.escape(string_value, True))
if value:
html += '<br><a href="?key=%s">%s</a>' % (cgi.escape(string_value, True),
cgi.escape(PseudoBreadcrumbs(value), True))
return html
def input_field_size(self):
return 85
def additional_short_value_html(self, value):
if not value:
return ''
return '<br><a href="./datastore/edit?key=%s">%s</a>' % (cgi.escape(str(value), True),
cgi.escape(PseudoBreadcrumbs(value), True))
class EmailType(StringType):
def name(self):
return 'Email'
def parse(self, value):
return datastore_types.Email(value)
def python_type(self):
return datastore_types.Email
class CategoryType(StringType):
def name(self):
return 'Category'
def parse(self, value):
return datastore_types.Category(value)
def python_type(self):
return datastore_types.Category
class LinkType(StringType):
def name(self):
return 'Link'
def parse(self, value):
return datastore_types.Link(value)
def python_type(self):
return datastore_types.Link
class GeoPtType(DataType):
def name(self):
return 'GeoPt'
def parse(self, value):
return datastore_types.GeoPt(value)
def python_type(self):
return datastore_types.GeoPt
class ImType(DataType):
def name(self):
return 'IM'
def parse(self, value):
return datastore_types.IM(value)
def python_type(self):
return datastore_types.IM
class PhoneNumberType(StringType):
def name(self):
return 'PhoneNumber'
def parse(self, value):
return datastore_types.PhoneNumber(value)
def python_type(self):
return datastore_types.PhoneNumber
class PostalAddressType(StringType):
def name(self):
return 'PostalAddress'
def parse(self, value):
return datastore_types.PostalAddress(value)
def python_type(self):
return datastore_types.PostalAddress
class RatingType(NumberType):
def name(self):
return 'Rating'
def parse(self, value):
return datastore_types.Rating(value)
def python_type(self):
return datastore_types.Rating
class NoneType(DataType):
def name(self):
return 'None'
def parse(self, value):
return None
def python_type(self):
return None
def format(self, value):
return 'None'
class BlobKeyType(StringType):
def name(self):
return 'BlobKey'
def parse(self, value):
return datastore_types.BlobKey(value)
def python_type(self):
return datastore_types.BlobKey
_DATA_TYPES = {
types.NoneType: NoneType(),
types.StringType: StringType(),
types.UnicodeType: StringType(),
datastore_types.Text: TextType(),
datastore_types.Blob: BlobType(),
types.BooleanType: BoolType(),
types.IntType: IntType(),
types.LongType: LongType(),
types.FloatType: FloatType(),
datetime.datetime: TimeType(),
users.User: UserType(),
datastore_types.Key: ReferenceType(),
types.ListType: ListType(),
datastore_types.Email: EmailType(),
datastore_types.Category: CategoryType(),
datastore_types.Link: LinkType(),
datastore_types.GeoPt: GeoPtType(),
datastore_types.IM: ImType(),
datastore_types.PhoneNumber: PhoneNumberType(),
datastore_types.PostalAddress: PostalAddressType(),
datastore_types.Rating: RatingType(),
datastore_types.BlobKey: BlobKeyType(),
datastore_types.ByteString: StringType(),
}
_NAMED_DATA_TYPES = {}
for data_type in _DATA_TYPES.values():
_NAMED_DATA_TYPES[data_type.name()] = data_type
def _ParseCronYaml():
"""Loads the cron.yaml file and parses it.
The CWD of the dev_appserver is the root of the application here.
Returns a dict representing the contents of cron.yaml.
"""
cronyaml_files = 'cron.yaml', 'cron.yml'
for cronyaml in cronyaml_files:
try:
fh = open(cronyaml, "r")
except IOError:
continue
try:
cron_info = croninfo.LoadSingleCron(fh)
return cron_info
finally:
fh.close()
return None
def PseudoBreadcrumbs(key):
"""Return a string that looks like the breadcrumbs (for key properties).
Args:
key: A datastore_types.Key object.
Returns:
A string looking like breadcrumbs.
"""
path = key.to_path()
parts = []
for i in range(0, len(path)//2):
kind = path[i*2]
if isinstance(kind, unicode):
kind = kind.encode('utf8')
value = path[i*2 + 1]
if isinstance(value, (int, long)):
parts.append('%s: id=%d' % (kind, value))
else:
if isinstance(value, unicode):
value = value.encode('utf8')
parts.append('%s: name=%s' % (kind, value))
return ' > '.join(parts)
def main():
handlers = [
('.*' + DatastoreQueryHandler.PATH, DatastoreQueryHandler),
('.*' + DatastoreEditHandler.PATH, DatastoreEditHandler),
('.*' + DatastoreBatchEditHandler.PATH, DatastoreBatchEditHandler),
('.*' + InteractivePageHandler.PATH, InteractivePageHandler),
('.*' + InteractiveExecuteHandler.PATH, InteractiveExecuteHandler),
('.*' + MemcachePageHandler.PATH, MemcachePageHandler),
('.*' + ImageHandler.PATH, ImageHandler),
('.*' + QueuesPageHandler.PATH, QueuesPageHandler),
('.*' + TasksPageHandler.PATH, TasksPageHandler),
('.*' + XMPPPageHandler.PATH, XMPPPageHandler),
('.*' + InboundMailPageHandler.PATH, InboundMailPageHandler),
('.*', DefaultPageHandler),
]
if HAVE_CRON:
handlers.insert(0, ('.*' + CronPageHandler.PATH, CronPageHandler))
application = webapp.WSGIApplication(handlers, debug=_DEBUG)
wsgiref.handlers.CGIHandler().run(application)
import django
if django.VERSION[:2] < (0, 97):
from django.template import defaultfilters
def safe(text, dummy=None):
return text
defaultfilters.register.filter("safe", safe)
if __name__ == '__main__':
main()
|