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
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
|
# imports from python libraries
import os
import hashlib
import datetime
import json
from itertools import chain # Using from_iterable()
# imports from installed packages
from django.contrib.auth.models import User
from django.db import models
from django_mongokit import connection
from django_mongokit import get_database
from django_mongokit.document import DjangoDocument
from mongokit import IS
from mongokit import OR
from mongokit import INDEX_ASCENDING, INDEX_DESCENDING
try:
from bson import ObjectId
except ImportError: # old pymongo
from pymongo.objectid import ObjectId
# imports from application folders/files
from gnowsys_ndf.settings import RCS_REPO_DIR
from gnowsys_ndf.settings import RCS_REPO_DIR_HASH_LEVEL
from gnowsys_ndf.settings import MARKUP_LANGUAGE
from gnowsys_ndf.settings import MARKDOWN_EXTENSIONS
from gnowsys_ndf.settings import GSTUDIO_GROUP_AGENCY_TYPES, GSTUDIO_AUTHOR_AGENCY_TYPES
from gnowsys_ndf.settings import META_TYPE
from gnowsys_ndf.ndf.rcslib import RCS
from django.dispatch import receiver
from registration.signals import user_registered
NODE_TYPE_CHOICES = (
('Nodes'),
('Attribute Types'),
('Attributes'),
('Relation Types'),
('Relations'),
('GSystem Types'),
('GSystems'),
('Node Specification'),
('Attribute Specification'),
('Relation Specification'),
('Intersection'),
('Complement'),
('Union'),
('Process Types'),
('Process')
)
TYPES_OF_GROUP = (
('PUBLIC'),
('PRIVATE'),
('ANONYMOUS')
)
EDIT_POLICY = (
('EDITABLE_NON_MODERATED'),
('EDITABLE_MODERATED'),
('NON_EDITABLE')
)
SUBSCRIPTION_POLICY = (
('OPEN'),
('BY_REQUEST'),
('BY_INVITATION'),
)
EXISTANCE_POLICY = (
('ANNOUNCED'),
('NOT_ANNOUNCED')
)
LIST_MEMBER_POLICY = (
('DISCLOSED_TO_MEM'),
('NOT_DISCLOSED_TO_MEM')
)
ENCRYPTION_POLICY = (
('ENCRYPTED'),
('NOT_ENCRYPTED')
)
DATA_TYPE_CHOICES = (
"None",
"bool",
"basestring",
"unicode",
"int",
"float",
"long",
"datetime.datetime",
"list",
"dict",
"ObjectId",
"IS()"
)
my_doc_requirement = u'storing_orignal_doc'
reduced_doc_requirement = u'storing_reduced_doc'
to_reduce_doc_requirement = u'storing_to_be_reduced_doc'
indexed_word_list_requirement = u'storing_indexed_words'
# CUSTOM DATA-TYPE DEFINITIONS
STATUS_CHOICES_TU = IS(u'DRAFT', u'HIDDEN', u'PUBLISHED', u'DELETED', u'MODERATION')
STATUS_CHOICES = tuple(str(qtc) for qtc in STATUS_CHOICES_TU)
QUIZ_TYPE_CHOICES_TU = IS(u'Short-Response', u'Single-Choice', u'Multiple-Choice')
QUIZ_TYPE_CHOICES = tuple(str(qtc) for qtc in QUIZ_TYPE_CHOICES_TU)
# FRAME CLASS DEFINITIONS
@receiver(user_registered)
def user_registered_handler(sender, user, request, **kwargs):
tmp_hold = node_collection.collection.node_holder()
dict_to_hold = {}
dict_to_hold['node_type'] = 'Author'
dict_to_hold['userid'] = user.id
agency_type = request.POST.get("agency_type", "")
if agency_type:
dict_to_hold['agency_type'] = agency_type
else:
# Set default value for agency_type as "Other"
dict_to_hold['agency_type'] = "Other"
dict_to_hold['group_affiliation'] = request.POST.get("group_affiliation", "")
tmp_hold.details_to_hold = dict_to_hold
tmp_hold.save()
return
@connection.register
class Node(DjangoDocument):
'''Everything is a Node. Other classes should inherit this Node class.
According to the specification of GNOWSYS, all nodes, including
types, metatypes and members of types, edges of nodes, should all
be Nodes.
Member of this class must belong to one of the NODE_TYPE_CHOICES.
Some in-built Edge names (Relation types) are defined in this
class: type_of, member_of, prior_node, post_node, collection_set,
group_set.
type_of is used to express generalization of Node. And member_of
to express its type. This type_of should not be confused with
_type. The latter expresses the Python classes defined in this
program that the object inherits. The former (type_of) is about
the data the application represents.
_type is useful in seggregating the nodes from the mongodb
collection, where all nodes are stored.
prior_node is to express that the current node depends in some way
to another node/s. post_node is seldom used. Currently we use it
to define sub-Group, and to set replies to a post in the Forum App.
Nodes are publisehed in one group or another, or in more than one
group. The groups in which a node is publisehed is expressed in
group_set.
'''
objects = models.Manager()
collection_name = 'Nodes'
structure = {
'_type': unicode, # check required: required field, Possible
# values are to be taken only from the list
# NODE_TYPE_CHOICES
'name': unicode,
'altnames': unicode,
'plural': unicode,
'prior_node': [ObjectId],
'post_node': [ObjectId],
'language': unicode,
'type_of': [ObjectId], # check required: only ObjectIDs of GSystemType
'member_of': [ObjectId], # check required: only ObjectIDs of
# GSystemType for GSystems, or only
# ObjectIDs of MetaTypes for
# GSystemTypes
'access_policy': unicode, # check required: only possible
# values are Public or Private. Why
# is this unicode?
'created_at': datetime.datetime,
'created_by': int, # test required: only ids of Users
'last_update': datetime.datetime,
'modified_by': int, # test required: only ids of Users
'contributors': [int], # test required: set of all ids of
# Users of created_by and modified_by
# fields
'location': [dict], # check required: this dict should be a
# valid GeoJason format
'content': unicode,
'content_org': unicode,
'group_set': [ObjectId], # check required: should not be
# empty. For type nodes it should be
# set to a Factory Group called
# Administration
'collection_set': [ObjectId], # check required: to exclude
# parent nodes as children, use
# MPTT logic
'property_order': [], # Determines the order & grouping in
# which attribute(s)/relation(s) are
# displayed in the form
'start_publication': datetime.datetime,
'tags': [unicode],
'featured': bool,
'url': unicode,
'comment_enabled': bool,
'login_required': bool,
# 'password': basestring,
'status': STATUS_CHOICES_TU,
'rating':[{'score':int,
'user_id':int,
'ip_address':basestring}]
}
required_fields = ['name', '_type'] # 'group_set' to be included
# here after the default
# 'Administration' group is
# ready.
default_values = {'created_at': datetime.datetime.utcnow, 'status': u'DRAFT'}
use_dot_notation = True
########## Setter(@x.setter) & Getter(@property) ##########
@property
def user_details_dict(self):
"""Retrieves names of created-by & modified-by users from the given
node, and appends those to 'user_details' dict-variable
"""
user_details = {}
if self.created_by:
user_details['created_by'] = User.objects.get(pk=self.created_by).username
contributor_names = []
for each_pk in self.contributors:
contributor_names.append(User.objects.get(pk=each_pk).username)
# user_details['modified_by'] = contributor_names
user_details['contributors'] = contributor_names
if self.modified_by:
user_details['modified_by'] = User.objects.get(pk=self.modified_by).username
return user_details
@property
def member_of_names_list(self):
"""Returns a list having names of each member (GSystemType, i.e Page,
File, etc.), built from 'member_of' field (list of ObjectIds)
"""
member_of_names = []
if self.member_of:
for each_member_id in self.member_of:
if type(each_member_id) == ObjectId:
_id = each_member_id
else:
_id = each_member_id['$oid']
if _id:
mem = node_collection.one({'_id': ObjectId(_id)})
if mem:
member_of_names.append(mem.name)
else:
if "gsystem_type" in self:
for each_member_id in self.gsystem_type:
if type(each_member_id) == ObjectId:
_id = each_member_id
else:
_id = each_member_id['$oid']
if _id:
mem = node_collection.one({'_id': ObjectId(_id)})
if mem:
member_of_names.append(mem.name)
return member_of_names
@property
def prior_node_dict(self):
"""Returns a dictionary consisting of key-value pair as
ObjectId-Document pair respectively for prior_node objects of
the given node.
"""
obj_dict = {}
i = 0
for each_id in self.prior_node:
i = i + 1
if each_id != self._id:
node_collection_object = node_collection.one({"_id": ObjectId(each_id)})
dict_key = i
dict_value = node_collection_object
obj_dict[dict_key] = dict_value
return obj_dict
@property
def collection_dict(self):
"""Returns a dictionary consisting of key-value pair as
ObjectId-Document pair respectively for collection_set objects
of the given node.
"""
obj_dict = {}
i = 0;
for each_id in self.collection_set:
i = i + 1
if each_id != self._id:
node_collection_object = node_collection.one({"_id": ObjectId(each_id)})
dict_key = i
dict_value = node_collection_object
obj_dict[dict_key] = dict_value
return obj_dict
@property
def html_content(self):
"""Returns the content in proper html-format.
"""
if MARKUP_LANGUAGE == 'markdown':
return markdown(self.content, MARKDOWN_EXTENSIONS)
elif MARKUP_LANGUAGE == 'textile':
return textile(self.content)
elif MARKUP_LANGUAGE == 'restructuredtext':
return restructuredtext(self.content)
return self.content
@property
def current_version(self):
history_manager = HistoryManager()
return history_manager.get_current_version(self)
@property
def version_dict(self):
"""Returns a dictionary containing list of revision numbers of the
given node.
Example:
{
"1": "1.1",
"2": "1.2",
"3": "1.3",
}
"""
history_manager = HistoryManager()
return history_manager.get_version_dict(self)
########## Built-in Functions (Overridden) ##########
def __unicode__(self):
return self._id
def identity(self):
return self.__unicode__()
def save(self, *args, **kwargs):
if "is_changed" in kwargs:
if not kwargs["is_changed"]:
#print "\n ", self.name, "(", self._id, ") -- Nothing has changed !\n\n"
return
is_new = False
if not "_id" in self:
is_new = True # It's a new document, hence yet no ID!"
# On save, set "created_at" to current date
self.created_at = datetime.datetime.today()
self.last_update = datetime.datetime.today()
# Check the fields which are not present in the class
# structure, whether do they exists in their GSystemType's
# "attribute_type_set"; If exists, add them to the document
# Otherwise, throw an error -- " Illegal access: Invalid field
# found!!! "
for key, value in self.iteritems():
if key == '_id':
continue
if not (key in self.structure):
field_found = False
for gst_id in self.member_of:
attribute_set_list = node_collection.one({'_id': gst_id}).attribute_type_set
for attribute in attribute_set_list:
if key == attribute['name']:
field_found = True
# TODO: Check whether type of "value"
# matches with that of
# "attribute['data_type']" Don't continue
# searching from list of remaining
# attributes
break
if field_found:
# Don't continue searching from list of
# remaining gsystem-types
break
if not field_found:
print "\n Invalid field(", key, ") found!!!\n"
# Throw an error: " Illegal access: Invalid field
# found!!! "
super(Node, self).save(*args, **kwargs)
#This is the save method of the node class.It is still not
#known on which objects is this save method applicable We
#still do not know if this save method is called for the
#classes which extend the Node Class or for every class There
#is a very high probability that it is called for classes
#which extend the Node Class only The classes which we have
#i.e. the MyReduce() and ToReduce() class do not extend from
#the node class Hence calling the save method on those objects
#should not create a recursive function
#If it is a new document then Make a new object of ToReduce
#class and the id of this document to that object else Check
#whether there is already an object of ToReduce() with the id
#of this object. If there is an object present pass else add
#that object I have not applied the above algorithm
#Instead what I have done is that I have searched the
#ToReduce() collection class and searched whether the ID of
#this document is present or not. If the id is not present
#then add that id.If it is present then do not add that id
old_doc = node_collection.collection.ToReduceDocs.find_one({'required_for':to_reduce_doc_requirement,'doc_id':self._id})
#print "~~~~~~~~~~~~~~~~~~~~It is not present in the ToReduce() class collection.Message Coming from save() method ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~",self._id
if not old_doc:
z = node_collection.collection.ToReduceDocs()
z.doc_id = self._id
z.required_for = to_reduce_doc_requirement
z.save()
#If you create/edit anything then this code shall add it in the URL
history_manager = HistoryManager()
rcs_obj = RCS()
if is_new:
# Create history-version-file
try:
if history_manager.create_or_replace_json_file(self):
fp = history_manager.get_file_path(self)
user = User.objects.get(pk=self.created_by).username
message = "This document (" + self.name + ") is created by " + user + " on " + self.created_at.strftime("%d %B %Y")
rcs_obj.checkin(fp, 1, message.encode('utf-8'), "-i")
except Exception as err:
print "\n DocumentError: This document (", self._id, ":", self.name, ") can't be created!!!\n"
node_collection.collection.remove({'_id': self._id})
raise RuntimeError(err)
else:
# Update history-version-file
fp = history_manager.get_file_path(self)
try:
rcs_obj.checkout(fp)
except Exception as err:
try:
if history_manager.create_or_replace_json_file(self):
fp = history_manager.get_file_path(self)
user = User.objects.get(pk=self.created_by).username
message = "This document (" + self.name + ") is re-created by " + user + " on " + self.created_at.strftime("%d %B %Y")
rcs_obj.checkin(fp, 1, message.encode('utf-8'), "-i")
except Exception as err:
print "\n DocumentError: This document (", self._id, ":", self.name, ") can't be re-created!!!\n"
node_collection.collection.remove({'_id': self._id})
raise RuntimeError(err)
try:
if history_manager.create_or_replace_json_file(self):
user = User.objects.get(pk=self.modified_by).username
message = "This document (" + self.name + ") is lastly updated by " + user + " status:" + self.status + " on " + self.last_update.strftime("%d %B %Y")
rcs_obj.checkin(fp, 1, message.encode('utf-8'))
except Exception as err:
print "\n DocumentError: This document (", self._id, ":", self.name, ") can't be updated!!!\n"
raise RuntimeError(err)
# User-Defined Functions
def get_possible_attributes(self, gsystem_type_id_or_list):
"""Returns user-defined attribute(s) of given node which belongs to
either given single/list of GType(s).
Keyword arguments: gsystem_type_id_or_list -- Single/List of
ObjectId(s) of GSystemTypes' to which the given node (self)
belongs
If node (self) has '_id' -- Node is created; indicating
possible attributes needs to be searched under GAttribute
collection & return value of those attributes (previously
existing) as part of the list along with attribute-data_type
Else -- Node needs to be created; indicating possible
attributes needs to be searched under AttributeType collection
& return default value 'None' of those attributes as part of
the list along with attribute-data_type
Returns: Dictionary that holds follwoing details:- Key -- Name
of the attribute Value, which inturn is a dictionary that
holds key and values as shown below:
{ 'attribute-type-name': { 'altnames': Value of AttributeType
node's altnames field, 'data_type': Value of AttributeType
node's data_type field, 'object_value': Value of GAttribute
node's object_value field } }
"""
gsystem_type_list = []
possible_attributes = {}
# Converts to list, if passed parameter is only single ObjectId
if not isinstance(gsystem_type_id_or_list, list):
gsystem_type_list = [gsystem_type_id_or_list]
else:
gsystem_type_list = gsystem_type_id_or_list
# Code for finding out attributes associated with each gsystem_type_id in the list
for gsystem_type_id in gsystem_type_list:
# Converts string representaion of ObjectId to it's corresponding ObjectId type, if found
if not isinstance(gsystem_type_id, ObjectId):
if ObjectId.is_valid(gsystem_type_id):
gsystem_type_id = ObjectId(gsystem_type_id)
else:
error_message = "\n ObjectIdError: Invalid ObjectId (" + gsystem_type_id + ") found while finding attributes !!!\n"
raise Exception(error_message)
# Case [A]: While editing GSystem
# Checking in Gattribute collection - to collect user-defined attributes' values, if already set!
if "_id" in self:
# If - node has key '_id'
attributes = triple_collection.find({'_type': "GAttribute", 'subject': self._id})
for attr_obj in attributes:
# attr_obj is of type - GAttribute [subject (node._id), attribute_type (AttributeType), object_value (value of attribute)]
# Must convert attr_obj.attribute_type [dictionary] to node_collection(attr_obj.attribute_type) [document-object]
AttributeType.append_attribute(node_collection.collection.AttributeType(attr_obj.attribute_type), possible_attributes, attr_obj.object_value)
# Case [B]: While creating GSystem / if new attributes get added
# Again checking in AttributeType collection - because to collect newly added user-defined attributes, if any!
attributes = node_collection.find({'_type': 'AttributeType', 'subject_type': gsystem_type_id})
for attr_type in attributes:
# Here attr_type is of type -- AttributeType
AttributeType.append_attribute(attr_type, possible_attributes)
# type_of check for current GSystemType to which the node belongs to
gsystem_type_node = node_collection.one({'_id': gsystem_type_id}, {'name': 1, 'type_of': 1})
if gsystem_type_node.type_of:
attributes = node_collection.find({'_type': 'AttributeType', 'subject_type': {'$in': gsystem_type_node.type_of}})
for attr_type in attributes:
# Here attr_type is of type -- AttributeType
AttributeType.append_attribute(attr_type, possible_attributes)
return possible_attributes
def get_possible_relations(self, gsystem_type_id_or_list):
"""Returns relation(s) of given node which belongs to either given
single/list of GType(s).
Keyword arguments: gsystem_type_id_or_list -- Single/List of
ObjectId(s) of GTypes' to which the given node (self) belongs
If node (self) has '_id' -- Node is created; indicating
possible relations need to be searched under GRelation
collection & return value of those relations (previously
existing) as part of the dict along with relation-type details
('object_type' and 'inverse_name')
Else -- Node needs to be created; indicating possible
relations need to be searched under RelationType collection &
return default value 'None' for those relations as part of the
dict along with relation-type details ('object_type' and
'inverse_name')
Returns: Dictionary that holds details as follows:- Key --
Name of the relation Value -- It's again a dictionary that
holds key and values as shown below:
{ // If inverse_relation - False 'relation-type-name': {
'altnames': Value of RelationType node's altnames field [0th
index-element], 'subject_or_object_type': Value of
RelationType node's object_type field, 'inverse_name': Value
of RelationType node's inverse_name field,
'subject_or_right_subject_list': List of Value(s) of GRelation
node's right_subject field }
// If inverse_relation - True 'relation-type-name': {
'altnames': Value of RelationType node's altnames field [1st
index-element], 'subject_or_object_type': Value of
RelationType node's subject_type field, 'inverse_name':
Value of RelationType node's name field,
'subject_or_right_subject_list': List of Value(s) of
GRelation node's subject field } }
"""
gsystem_type_list = []
possible_relations = {}
# Converts to list, if passed parameter is only single ObjectId
if not isinstance(gsystem_type_id_or_list, list):
gsystem_type_list = [gsystem_type_id_or_list]
else:
gsystem_type_list = gsystem_type_id_or_list
# Code for finding out relations associated with each gsystem_type_id in the list
for gsystem_type_id in gsystem_type_list:
# Converts string representaion of ObjectId to it's corresponding ObjectId type, if found
if not isinstance(gsystem_type_id, ObjectId):
if ObjectId.is_valid(gsystem_type_id):
gsystem_type_id = ObjectId(gsystem_type_id)
else:
error_message = "\n ObjectIdError: Invalid ObjectId (" + gsystem_type_id + ") found while finding relations !!!\n"
raise Exception(error_message)
# Relation
inverse_relation = False
# Case - While editing GSystem Checking in GRelation
# collection - to collect relations' values, if already
# set!
if "_id" in self:
# If - node has key '_id'
relations = triple_collection.find({'_type': "GRelation", 'subject': self._id, 'status': u"PUBLISHED"})
for rel_obj in relations:
# rel_obj is of type - GRelation
# [subject(node._id), relation_type(RelationType),
# right_subject(value of related object)] Must
# convert rel_obj.relation_type [dictionary] to
# collection.Node(rel_obj.relation_type)
# [document-object]
RelationType.append_relation(
node_collection.collection.RelationType(rel_obj.relation_type),
possible_relations, inverse_relation, rel_obj.right_subject
)
# Case - While creating GSystem / if new relations get
# added Checking in RelationType collection - because to
# collect newly added user-defined relations, if any!
relations = node_collection.find({'_type': 'RelationType', 'subject_type': gsystem_type_id})
for rel_type in relations:
# Here rel_type is of type -- RelationType
RelationType.append_relation(rel_type, possible_relations, inverse_relation)
# type_of check for current GSystemType to which the node
# belongs to
gsystem_type_node = node_collection.one({'_id': gsystem_type_id}, {'name': 1, 'type_of': 1})
if gsystem_type_node.type_of:
relations = node_collection.find({'_type': 'RelationType', 'subject_type': {'$in': gsystem_type_node.type_of}})
for rel_type in relations:
# Here rel_type is of type -- RelationType
RelationType.append_relation(rel_type, possible_relations, inverse_relation)
# Inverse-Relation
inverse_relation = True
# Case - While editing GSystem Checking in GRelation
# collection - to collect inverse-relations' values, if
# already set!
if "_id" in self:
# If - node has key '_id'
relations = triple_collection.find({'_type': "GRelation", 'right_subject': self._id, 'status': u"PUBLISHED"})
for rel_obj in relations:
# rel_obj is of type - GRelation
# [subject(node._id), relation_type(RelationType),
# right_subject(value of related object)] Must
# convert rel_obj.relation_type [dictionary] to
# collection.Node(rel_obj.relation_type)
# [document-object]
if META_TYPE[4] in rel_obj.relation_type.member_of_names_list:
# We are not handling inverse relation processing for
# Triadic relationship(s)
continue
RelationType.append_relation(
node_collection.collection.RelationType(rel_obj.relation_type),
possible_relations, inverse_relation, rel_obj.subject
)
# Case - While creating GSystem / if new relations get
# added Checking in RelationType collection - because to
# collect newly added user-defined relations, if any!
relations = node_collection.find({'_type': 'RelationType', 'object_type': gsystem_type_id})
for rel_type in relations:
# Here rel_type is of type -- RelationType
RelationType.append_relation(rel_type, possible_relations, inverse_relation)
# type_of check for current GSystemType to which the node
# belongs to
gsystem_type_node = node_collection.one({'_id': gsystem_type_id}, {'name': 1, 'type_of': 1})
if gsystem_type_node.type_of:
relations = node_collection.find({'_type': 'RelationType', 'object_type': {'$in': gsystem_type_node.type_of}})
for rel_type in relations:
# Here rel_type is of type -- RelationType
RelationType.append_relation(rel_type, possible_relations, inverse_relation)
return possible_relations
def get_neighbourhood(self, member_of):
"""Attaches attributes and relations of the node to itself;
i.e. key's types to it's structure and key's values to itself
"""
attributes = self.get_possible_attributes(member_of)
for key, value in attributes.iteritems():
self.structure[key] = value['data_type']
self[key] = value['object_value']
relations = self.get_possible_relations(member_of)
for key, value in relations.iteritems():
self.structure[key] = value['subject_or_object_type']
self[key] = value['subject_or_right_subject_list']
@connection.register
class AttributeType(Node):
'''To define reusable properties that can be set as possible
attributes to a GSystemType. A set of possible properties defines
a GSystemType.
'''
structure = {
'data_type': basestring, # check required: only of the DATA_TYPE_CHOICES
'complex_data_type': [unicode], # can be a list or a dictionary
'subject_type': [ObjectId], # check required: only one of Type
# Nodes. GSystems cannot be set as
# subject_types
'applicable_node_type': [basestring], # can be one or more
# than one of
# NODE_TYPE_CHOICES
'verbose_name': basestring,
'null': bool,
'blank': bool,
'help_text': unicode,
'max_digits': int, # applicable if the datatype is a number
'decimal_places': int, # applicable if the datatype is a float
'auto_now': bool,
'auto_now_add': bool,
'upload_to': unicode,
'path': unicode,
'verify_exist': bool,
'min_length': int,
'required': bool,
'label': unicode,
'unique': bool,
'validators': list,
'default': unicode,
'editable': bool
}
required_fields = ['data_type', 'subject_type']
use_dot_notation = True
########## User-Defined Functions ##########
@staticmethod
def append_attribute(attr_id_or_node, attr_dict, attr_value=None, inner_attr_dict=None):
if isinstance(attr_id_or_node, unicode):
# Convert unicode representation of ObjectId into it's
# corresponding ObjectId type Then fetch
# attribute-type-node from AttributeType collection of
# respective ObjectId
if ObjectId.is_valid(attr_id_or_node):
attr_id_or_node = node_collection.one({'_type': 'AttributeType', '_id': ObjectId(attr_id_or_node)})
else:
print "\n Invalid ObjectId: ", attr_id_or_node, " is not a valid ObjectId!!!\n"
# Throw indicating the same
if not attr_id_or_node.complex_data_type:
# Code for simple data-type Simple data-types: int, float,
# ObjectId, list, dict, basestring, unicode
if inner_attr_dict is not None:
# If inner_attr_dict exists It means node should ne
# added to this inner_attr_dict and not to attr_dict
if not (attr_id_or_node.name in inner_attr_dict):
# If inner_attr_dict[attr_id_or_node.name] key
# doesn't exists, then only add it!
if attr_value is None:
inner_attr_dict[attr_id_or_node.name] = {
'altnames': attr_id_or_node.altnames, '_id': attr_id_or_node._id,
'data_type': eval(attr_id_or_node.data_type),
'object_value': attr_value
}
else:
inner_attr_dict[attr_id_or_node.name] = {
'altnames': attr_id_or_node.altnames, '_id': attr_id_or_node._id,
'data_type': eval(attr_id_or_node.data_type),
'object_value': attr_value[attr_id_or_node.name]
}
if attr_id_or_node.name in attr_dict:
# If this attribute-node exists in outer
# attr_dict, then remove it
del attr_dict[attr_id_or_node.name]
else:
# If inner_attr_dict is None
if not (attr_id_or_node.name in attr_dict):
# If attr_dict[attr_id_or_node.name] key doesn't
# exists, then only add it!
attr_dict[attr_id_or_node.name] = {
'altnames': attr_id_or_node.altnames, '_id': attr_id_or_node._id,
'data_type': eval(attr_id_or_node.data_type),
'object_value': attr_value
}
else:
# Code for complex data-type
# Complex data-types: [...], {...}
if attr_id_or_node.data_type == "dict":
if not (attr_id_or_node.name in attr_dict):
inner_attr_dict = {}
for c_attr_id in attr_id_or_node.complex_data_type:
# NOTE: Here c_attr_id is in unicode format
# Hence, this function first converts attr_id
# to ObjectId format if unicode found
AttributeType.append_attribute(c_attr_id, attr_dict, attr_value, inner_attr_dict)
attr_dict[attr_id_or_node.name] = inner_attr_dict
else:
for remove_attr_name in attr_dict[attr_id_or_node.name].iterkeys():
if remove_attr_name in attr_dict:
# If this attribute-node exists in outer
# attr_dict, then remove it
del attr_dict[remove_attr_name]
elif attr_id_or_node.data_type == "list":
if len(attr_id_or_node.complex_data_type) == 1:
# Represents list of simple data-types
# Ex: [int], [ObjectId], etc.
dt = unicode("[" + attr_id_or_node.complex_data_type[0] + "]")
if not (attr_id_or_node.name in attr_dict):
# If attr_dict[attr_id_or_node.name] key
# doesn't exists, then only add it!
attr_dict[attr_id_or_node.name] = {
'altnames': attr_id_or_node.altnames, '_id': attr_id_or_node._id,
'data_type': eval(dt),
'object_value': attr_value
}
else:
# Represents list of complex data-types Ex:
# [{...}]
for c_attr_id in attr_id_or_node.complex_data_type:
if not ObjectId.is_valid(c_attr_id):
# If basic data-type values are found,
# pass the iteration
continue
# If unicode representation of ObjectId is
# found
AttributeType.append_attribute(c_attr_id, attr_dict, attr_value)
elif attr_id_or_node.data_type == "IS()":
# Below code does little formatting, for example:
# data_type: "IS()" complex_value: [u"ab", u"cd"] dt:
# "IS(u'ab', u'cd')"
dt = "IS("
for v in attr_id_or_node.complex_data_type:
dt = dt + "u'" + v + "'" + ", "
dt = dt[:(dt.rfind(", "))] + ")"
if not (attr_id_or_node.name in attr_dict):
# If attr_dict[attr_id_or_node.name] key doesn't
# exists, then only add it!
attr_dict[attr_id_or_node.name] = {
'altnames': attr_id_or_node.altnames, '_id': attr_id_or_node._id,
'data_type': eval(dt),
'object_value': attr_value
}
@connection.register
class RelationType(Node):
structure = {
'inverse_name': unicode,
'subject_type': [ObjectId], # ObjectId's of Any Class
'object_type': [OR(ObjectId, list)], # ObjectId's of Any Class
'subject_cardinality': int,
'object_cardinality': int,
'subject_applicable_nodetype': basestring, # NODE_TYPE_CHOICES [default (GST)]
'object_applicable_nodetype': basestring,
'slug': basestring,
'is_symmetric': bool,
'is_reflexive': bool,
'is_transitive': bool
}
required_fields = ['inverse_name', 'subject_type', 'object_type']
use_dot_notation = True
# User-Defined Functions ##########
@staticmethod
def append_relation(
rel_type_node, rel_dict, inverse_relation, left_or_right_subject=None
):
"""Appends details of a relation in format described below.
Keyword arguments:
rel_type_node -- Document of RelationType
node rel_dict -- Dictionary to which relation-details are
appended inverse_relation -- Boolean variable that indicates
whether appending an relation or inverse-relation
left_or_right_subject -- Actual value of related-subjects
(only if provided, otherwise by default it's None)
Returns: Dictionary that holds details as follows: Key -- Name
of the relation Value -- It's again a dictionary that holds
key and values as shown below: { // If inverse_relation -
False 'relation-type-name': { 'altnames': Value of
RelationType node's altnames field [0th index-element],
'subject_or_object_type': Value of RelationType node's
object_type field, 'inverse_name': Value of RelationType
node's inverse_name field, 'subject_or_right_subject_list':
List of Value(s) of GRelation node's right_subject field }
// If inverse_relation - True 'relation-type-name': {
'altnames': Value of RelationType node's altnames field [1st
index-element], 'subject_or_object_type': Value of
RelationType node's subject_type field, 'inverse_name':
Value of RelationType node's name field,
'subject_or_right_subject_list': List of Value(s) of
GRelation node's subject field } }
"""
left_or_right_subject_node = None
if left_or_right_subject:
if META_TYPE[3] in rel_type_node.member_of_names_list:
# If Binary relationship found
left_or_right_subject_node = node_collection.one({
'_id': left_or_right_subject
})
else:
left_or_right_subject_node = []
for each in left_or_right_subject:
each_node = node_collection.one({
'_id': each
})
left_or_right_subject_node.append(each_node)
if not left_or_right_subject_node:
error_message = "\n AppendRelationError: Right subject with " \
+ "this ObjectId(" + str(left_or_right_subject) + ") " \
+ "doesn't exists !!!"
raise Exception(error_message)
rel_name = ""
opp_rel_name = ""
alt_names = ""
subject_or_object_type = None
if inverse_relation:
# inverse_relation = True
# Means looking from object type
# relation-type's name & inverse-name will be swapped
rel_name = rel_type_node.inverse_name
opp_rel_name = rel_type_node.name
if rel_type_node.altnames:
if ";" in rel_type_node.altnames:
alt_names = rel_type_node.altnames.split(";")[1]
else:
alt_names = u""
subject_or_object_type = rel_type_node.subject_type
else:
# inverse_relation = False
# Means looking from subject type
# relation-type's name & inverse-name will be as it is
rel_name = rel_type_node.name
opp_rel_name = rel_type_node.inverse_name
if rel_type_node.altnames:
if ";" in rel_type_node.altnames:
alt_names = rel_type_node.altnames.split(";")[0]
else:
alt_names = u""
subject_or_object_type = rel_type_node.object_type
if not (rel_name in rel_dict):
subject_or_right_subject_list = [left_or_right_subject_node] if left_or_right_subject_node else []
rel_dict[rel_name] = {
'altnames': alt_names,
'subject_or_object_type': subject_or_object_type,
'inverse_name': opp_rel_name,
'subject_or_right_subject_list': subject_or_right_subject_list
}
else:
subject_or_right_subject_list = rel_dict[rel_name]["subject_or_right_subject_list"] if rel_dict[rel_name]["subject_or_right_subject_list"] else []
if left_or_right_subject_node:
if not (left_or_right_subject_node in subject_or_right_subject_list):
subject_or_right_subject_list.append(left_or_right_subject_node)
rel_dict[rel_name]["subject_or_right_subject_list"] = subject_or_right_subject_list
rel_dict[rel_name]["_id"] = rel_type_node._id
return rel_dict
@connection.register
class MetaType(Node):
"""MetaType class: Its members are any of GSystemType, AttributeType,
RelationType, ProcessType.
It is used to express the NodeTypes that are part of an
Application developed using GNOWSYS-Studio. E.g, a GSystemType
'Page' or 'File' become applications by expressing them as members
of a MetaType, 'GAPP'.
"""
structure = {
'description': basestring, # Description (name)
'attribute_type_set': [AttributeType], # Embed list of Attribute Type Class as Documents
'relation_type_set': [RelationType], # Holds list of Relation Types
'parent': ObjectId # Foreign key to self
}
use_dot_notation = True
class ProcessType(Node):
"""A kind of nodetype for defining processes or events or temporal
objects involving change.
"""
structure = {
'changing_attributetype_set': [AttributeType], # List of Attribute Types
'changing_relationtype_set': [RelationType] # List of Relation Types
}
use_dot_notation = True
# user should have a list of groups attributeType added should
# automatically be added to the attribute_type_set of GSystemType
@connection.register
class GSystemType(Node):
"""Class to generalize GSystems
"""
structure = {
'meta_type_set': [MetaType], # List of Metatypes
'attribute_type_set': [AttributeType], # Embed list of Attribute Type Class as Documents
'relation_type_set': [RelationType], # Holds list of Relation Types
'process_type_set': [ProcessType], # List of Process Types
'property_order': [] # List of user-defined attributes in template-view order
}
use_dot_notation = True
use_autorefs = True # To support Embedding of Documents
@connection.register
class GSystem(Node):
"""GSystemType instance
"""
use_schemaless = True
structure = {
'attribute_set': [dict], # ObjectIds of GAttributes
'relation_set': [dict], # ObjectIds of GRelations
'module_set': [dict], # Holds the ObjectId & SnapshotID (version_number) of collection elements
# along with their sub-collection elemnts too
'author_set': [int], # List of Authors
'annotations': [dict], # List of json files for annotations on the page
'license': basestring # contains license/s in string format
}
use_dot_notation = True
@connection.register
class File(GSystem):
"""File class to hold any resource
"""
structure = {
'mime_type': basestring, # Holds the type of file
'fs_file_ids': [ObjectId], # Holds the List of ids of file stored in gridfs
'file_size': {
'size': float,
'unit': unicode
} # dict used to hold file size in int and unit palace in term of KB,MB,GB
}
gridfs = {
'containers': ['files']
}
use_dot_notation = True
@connection.register
class Group(GSystem):
"""Group class to create collection (group) of members
"""
structure = {
'group_type': basestring, # Types of groups - Anonymous, public or private
'edit_policy': basestring, # Editing policy of the group - non editable,editable moderated or editable non-moderated
'subscription_policy': basestring, # Subscription policy to this group - open, by invitation, by request
'visibility_policy': basestring, # Existance of the group - announced or not announced
'disclosure_policy': basestring, # Members of this group - disclosed or not
'encryption_policy': basestring, # Encryption - yes or no
'agency_type': basestring, # A choice field such as Pratner,Govt.Agency, NGO etc.
'group_admin': [int], # ObjectId of Author class
'moderation_level': int # range from 0 till any integer level
}
use_dot_notation = True
default_values = {'moderation_level': -1}
validators = {
'group_type': lambda x: x in TYPES_OF_GROUP,
'edit_policy': lambda x: x in EDIT_POLICY,
'subscription_policy': lambda x: x in SUBSCRIPTION_POLICY,
'visibility_policy': lambda x: x in EXISTANCE_POLICY,
'disclosure_policy': lambda x: x in LIST_MEMBER_POLICY,
'encryption_policy': lambda x: x in ENCRYPTION_POLICY,
'agency_type': lambda x: x in GSTUDIO_GROUP_AGENCY_TYPES,
# 'name': lambda x: x not in \
# [ group_obj['name'] for group_obj in \
# node_collection.find({'_type': 'Group'}, {'name': 1, '_id': 0})]
}
def is_gstaff(self, user):
"""
Checks whether given user belongs to GStaff.
GStaff includes only the following users of a group:
1) Super-user (Django's superuser)
2) Creator of the group (created_by field)
3) Admin-user of the group (group_admin field)
Other memebrs (author_set field) doesn't belongs to GStaff.
Arguments:
self -- Node of the currently selected group
user -- User object taken from request object
Returns:
True -- If user is one of them, from the above specified list of categories.
False -- If above criteria is not met (doesn't belongs to any of the category, mentioned above)!
"""
if (user.is_superuser) or (user.id == self.created_by) or (user.id in self.group_admin):
return True
else:
return False
@connection.register
class Author(Group):
"""Author class to store django user instances
"""
structure = {
'email': unicode,
'password': unicode,
'visited_location': [],
'preferred_languages': dict, # preferred languages for users like preferred lang. , fall back lang. etc.
'group_affiliation': basestring
}
use_dot_notation = True
validators = {
'agency_type': lambda x: x in GSTUDIO_AUTHOR_AGENCY_TYPES # agency_type inherited from Group class
}
required_fields = ['name', 'password']
def __init__(self, *args, **kwargs):
super(Author, self).__init__(*args, **kwargs)
def __eq__(self, other_user):
# found that otherwise millisecond differences in created_at is compared
try:
other_id = other_user['_id']
except (AttributeError, TypeError):
return False
return self['_id'] == other_id
@property
def id(self):
return self.name
def password_crypt(self, password):
password_salt = str(len(password))
crypt = hashlib.sha1(password[::-1].upper() + password_salt).hexdigest()
PASSWORD = unicode(crypt, 'utf-8')
return PASSWORD
def is_anonymous(self):
return False
def is_authenticated(self):
return True
# HELPER -- CLASS DEFINITIONS
class HistoryManager():
"""Handles history management for documents of a collection
using Revision Control System (RCS).
"""
objects = models.Manager()
__RCS_REPO_DIR = RCS_REPO_DIR
def __init__(self):
pass
def check_dir_path(self, dir_path):
"""Checks whether path exists; and if not it creates that path.
Arguments:
(1) dir_path -- a string value representing an absolute path
Returns: Nothing
"""
dir_exists = os.path.isdir(dir_path)
if not dir_exists:
os.makedirs(dir_path)
def get_current_version(self, document_object):
"""Returns the current version/revision number of the given document instance.
"""
fp = self.get_file_path(document_object)
rcs = RCS()
return rcs.head(fp)
def get_version_dict(self, document_object):
"""Returns a dictionary containing list of revision numbers.
Example:
{
"1": "1.1",
"2": "1.2",
"3": "1.3",
}
"""
fp = self.get_file_path(document_object)
rcs = RCS()
# current_rev = rcs.head(fp) # Say, 1.4
total_no_of_rev = int(rcs.info(fp)["total revisions"]) # Say, 4
version_dict = {}
for i, j in zip(range(total_no_of_rev), reversed(range(total_no_of_rev))):
version_dict[(j + 1)] = rcs.calculateVersionNumber(fp, (i))
return version_dict
def get_file_path(self, document_object):
"""Returns absolute filesystem path for a json-file.
This path is combination of :-
(a) collection_directory_path: path to the collection-directory
to which the given instance belongs
(b) hashed_directory_structure: path built from object id based
on the set hashed-directory-level
(c) file_name: '.json' extension concatenated with object id of
the given instance
Arguments:
(1) document_object -- an instance of a collection
Returns: a string representing json-file's path
"""
file_name = (document_object._id.__str__() + '.json')
collection_dir = \
(os.path.join(self.__RCS_REPO_DIR, \
document_object.collection_name))
# Example:
# if -- file_name := "523f59685a409213818e3ec6.json"
# then -- collection_hash_dirs := "6/c/3/8/
# -- from last (2^0)pos/(2^1)pos/(2^2)pos/(2^3)pos/../(2^n)pos"
# here n := hash_level_num
collection_hash_dirs = ""
for pos in range(0, RCS_REPO_DIR_HASH_LEVEL):
collection_hash_dirs += \
(document_object._id.__str__()[-2**pos] + "/")
file_path = \
os.path.join(collection_dir, \
(collection_hash_dirs + file_name))
return file_path
def create_rcs_repo_collections(self, *versioning_collections):
"""Creates Revision Control System (RCS) repository.
After creating rcs-repo, it also creates sub-directories
for each collection inside it.
Arguments:
(1) versioning_collections -- a list representing collection-names
Returns: Nothing
"""
try:
self.check_dir_path(self.__RCS_REPO_DIR)
except OSError as ose:
print("\n\n RCS repository not created!!!\n {0}: {1}\n"\
.format(ose.errno, ose.strerror))
else:
print("\n\n RCS repository created @ following path:\n {0}\n"\
.format(self.__RCS_REPO_DIR))
# for collection in versioning_collections:
# rcs_repo_collection = os.path.join(self.__RCS_REPO_DIR, \
# collection)
# try:
# os.makedirs(rcs_repo_collection)
# except OSError as ose:
# print(" {0} collection-directory under RCS repository "\
# "not created!!!\n Error #{1}: {2}\n"\
# .format(collection, ose.errno, ose.strerror))
# else:
# print(" {0} collection-directory under RCS repository "\
# "created @ following path:\n {1}\n"\
# .format(collection, rcs_repo_collection))
def create_or_replace_json_file(self, document_object=None):
"""Creates/Overwrites a json-file for passed document object in
its respective hashed-directory structure.
Arguments:
(1) document_object -- an instance of document of a collection
Returns: A boolean value indicating whether created successfully
(a) True - if created
(b) False - Otherwise
"""
collection_tuple = (MetaType, GSystemType, GSystem, AttributeType, GAttribute, RelationType, GRelation)
file_res = False # True, if no error/exception occurred
if document_object is not None and \
isinstance(document_object, collection_tuple):
file_path = self.get_file_path(document_object)
json_data = document_object.to_json_type()
#------------------------------------------------------------------
# Creating/Overwriting data into json-file and rcs-file
#------------------------------------------------------------------
# file_mode as w:-
# Opens a file for writing only.
# Overwrites the file if the file exists.
# If the file does not exist, creates a new file for writing.
file_mode = 'w'
rcs_file = None
try:
self.check_dir_path(os.path.dirname(file_path))
rcs_file = open(file_path, file_mode)
except OSError as ose:
print("\n\n Json-File not created: Hashed directory "\
"structure doesn't exists!!!")
print("\n {0}: {1}\n".format(ose.errno, ose.strerror))
except IOError as ioe:
print(" " + str(ioe))
print("\n\n Please refer following command from "\
"\"Get Started\" file:\n"\
"\tpython manage.py initrcsrepo\n")
except Exception as e:
print(" Unexpected error : " + str(e))
else:
rcs_file.write(json.dumps(json_data,
sort_keys=True,
indent=4,
separators=(',', ': '),
cls=NodeJSONEncoder
)
)
# TODO: Commit modifications done to the file into
# it's rcs-version-file
file_res = True
finally:
if rcs_file is not None:
rcs_file.close()
else:
# TODO: Throw/raise error having following message!
# if document_object is None or
# !isinstance(document_object, collection_tuple)
msg = " Following instance is either invalid or " \
+ "not matching given instances-type list " + str(collection_tuple) + ":-" \
+ "\n\tObjectId: " + document_object._id.__str__() \
+ "\n\t Type: " + document_object._type \
+ "\n\t Name: " + document_object.name
raise RuntimeError(msg)
return file_res
def get_version_document(self, document_object, version_no=""):
"""Returns an object representing mongodb document instance of a given version number.
"""
if version_no == "":
version_no = self.get_current_version(document_object)
fp = self.get_file_path(document_object)
rcs = RCS()
rcs.checkout((fp, version_no))
json_data = ""
with open(fp, 'r') as version_file:
json_data = version_file.read()
# assigning None value to key, which is not present in json_data compare to Node class keys
null = 0
import json
json_dict = json.loads(json_data)
json_node_keys = document_object.keys()
json_dict_keys = json_dict.keys()
diff_keys = list(set(json_node_keys)-set(json_dict_keys))
if diff_keys:
for each in diff_keys:
json_dict[each]=None
json_data = json.dumps(json_dict)
# Converts the json-formatted data into python-specific format
doc_obj = node_collection.from_json(json_data)
rcs.checkin(fp)
# Below Code temporary resolves the problem of '$oid' This
# problem occurs when we convert mongodb's document into
# json-format using mongokit's to_json_type() function - It
# converts ObjectId() type into corresponding format
# "{u'$oid': u'24-digit-hexstring'}" But actual problem comes
# into picture when we have a field whose data-type is "list
# of ObjectIds" In case of '_id' field (automatically created
# by mongodb), mongokit handles this conversion and does so
# But not in case of "list of ObjectIds", it still remains in
# above given format and causes problem
for k, v in doc_obj.iteritems():
oid_list_str = ""
oid_ObjectId_list = []
if v and type(v) == list:
oid_list_str = v.__str__()
try:
if '$oid' in oid_list_str: #v.__str__():
for oid_dict in v:
oid_ObjectId = ObjectId(oid_dict['$oid'])
oid_ObjectId_list.append(oid_ObjectId)
doc_obj[k] = oid_ObjectId_list
except Exception as e:
print "\n Exception for document's ("+doc_obj.name+") key ("+k+") -- ", str(e), "\n"
return doc_obj
class NodeJSONEncoder(json.JSONEncoder):
def default(self, o):
if isinstance(o, ObjectId):
return str(o)
if isinstance(o, datetime.datetime):
return o.strftime("%d/%m/%Y %H:%M:%S")
return json.JSONEncoder.default(self, o)
# Benchmarking Class Defination
@connection.register
class Benchmark(DjangoDocument):
objects = models.Manager()
collection_name = 'Benchmarks'
structure = {
'_type':unicode,
'name': unicode,
'time_taken':unicode,
'parameters':unicode,
'size_of_parameters':unicode,
'function_output_length':unicode,
'calling_url':unicode,
'last_update': datetime.datetime
}
required_fields = ['name']
use_dot_notation = True
def __unicode__(self):
return self._id
def identity(self):
return self.__unicode__()
# TRIPLE CLASS DEFINITIONS
@connection.register
class Triple(DjangoDocument):
objects = models.Manager()
collection_name = 'Triples'
structure = {
'_type': unicode,
'name': unicode,
'subject_scope': basestring,
'subject': ObjectId, # ObjectId's of GSystem Class
'lang': basestring, # Put validation for standard language codes
'status': STATUS_CHOICES_TU
}
required_fields = ['name', 'subject']
use_dot_notation = True
use_autorefs = True
########## Built-in Functions (Overridden) ##########
def __unicode__(self):
return self._id
def identity(self):
return self.__unicode__()
def save(self, *args, **kwargs):
is_new = False
if "_id" not in self:
is_new = True # It's a new document, hence yet no ID!"
"""
Check for correct GSystemType match in AttributeType and GAttribute, similarly for RelationType and GRelation
"""
subject_system_flag = False
subject_id = self.subject
subject_document = node_collection.one({"_id": self.subject})
subject_name = subject_document.name
subject_type_list = []
subject_member_of_list = []
name_value = u""
if self._type == "GAttribute":
attribute_type_name = self.attribute_type['name']
attribute_object_value = unicode(self.object_value)
self.name = "%(subject_name)s -- %(attribute_type_name)s -- %(attribute_object_value)s" % locals()
name_value = self.name
subject_type_list = self.attribute_type['subject_type']
subject_member_of_list = subject_document.member_of
intersection = set(subject_member_of_list) & set(subject_type_list)
if intersection:
subject_system_flag = True
else:
# If instersection is not found with member_of fields' ObjectIds,
# then check for type_of field of each one of the member_of node
for gst_id in subject_member_of_list:
gst_node = node_collection.one({'_id': gst_id}, {'type_of': 1})
if set(gst_node.type_of) & set(subject_type_list):
subject_system_flag = True
break
elif self._type == "GRelation":
subject_type_list = self.relation_type['subject_type']
object_type_list = self.relation_type['object_type']
left_subject_member_of_list = subject_document.member_of
relation_type_name = self.relation_type['name']
if META_TYPE[4] in self.relation_type.member_of_names_list:
# print META_TYPE[3], self.relation_type.member_of_names_list,"!!!!!!!!!!!!!!!!!!!!!"
# Relationship Other than Binary one found; e.g, Triadic
# Single relation: [ObjectId(), ObjectId(), ...]
# Multi relation: [[ObjectId(), ObjectId(), ...], [ObjectId(), ObjectId(), ...], ...]
right_subject_member_of_list = []
right_subject_member_of_list_append = right_subject_member_of_list.append
right_subject_name_list = []
right_subject_name_list_append = right_subject_name_list.append
print self.right_subject,"%%%%%%%%%%%%%",type(self.right_subject)
for each in self.right_subject:
# Here each is an ObjectId
right_subject_document = node_collection.one({
"_id": each
}, {
"name": 1, "member_of": 1
})
right_subject_member_of_list_append(right_subject_document.member_of)
right_subject_name_list_append(right_subject_document.name)
right_subject_name_list_str = " >> ".join(right_subject_name_list)
self.name = "%(subject_name)s -- %(relation_type_name)s -- %(right_subject_name_list_str)s" % locals()
# Very much required as list comparison using set doesn't work
# with list as it's sub-elements
# Hence, converting list into comma separated values by extending
# with other comma-separated values from another list(s)
object_type_list = list(chain.from_iterable(object_type_list))
right_subject_member_of_list = list(chain.from_iterable(right_subject_member_of_list))
else:
#META_TYPE[3] in self.relation_type.member_of_names_list:
# If Binary relationship found
# Single relation: ObjectId()
# Multi relation: [ObjectId(), ObjectId(), ...]
right_subject_document = node_collection.one({'_id': self.right_subject})
right_subject_member_of_list = right_subject_document.member_of
right_subject_name = right_subject_document.name
self.name = "%(subject_name)s -- %(relation_type_name)s -- %(right_subject_name)s" % locals()
name_value = self.name
left_intersection = set(subject_type_list) & set(left_subject_member_of_list)
right_intersection = set(object_type_list) & set(right_subject_member_of_list)
if left_intersection and right_intersection:
subject_system_flag = True
else:
left_subject_system_flag = False
if left_intersection:
left_subject_system_flag = True
else:
for gst_id in left_subject_member_of_list:
gst_node = node_collection.one({'_id': gst_id}, {'type_of': 1})
if set(gst_node.type_of) & set(subject_type_list):
left_subject_system_flag = True
break
right_subject_system_flag = False
if right_intersection:
right_subject_system_flag = True
else:
for gst_id in right_subject_member_of_list:
gst_node = node_collection.one({'_id': gst_id}, {'type_of': 1})
if set(gst_node.type_of) & set(object_type_list):
right_subject_system_flag = True
break
if left_subject_system_flag and right_subject_system_flag:
subject_system_flag = True
if self._type =="GRelation" and subject_system_flag == False:
# print "The 2 lists do not have any common element"
raise Exception("\n Cannot create the GRelation ("+name_value+") as the subject/object that you have mentioned is not a member of a GSytemType for which this RelationType is defined!!!\n")
if self._type =="GAttribute" and subject_system_flag == False:
# print "\n The 2 lists do not have any common element\n"
error_message = "\n "+name_value+ " -- subject_type_list ("+str(subject_type_list)+") -- subject_member_of_list ("+str(subject_member_of_list)+") \n"
raise Exception(error_message + "Cannot create the GAttribute ("+name_value+") as the subject that you have mentioned is not a member of a GSystemType which this AttributeType is defined")
#it's me
#check for data_type in GAttribute case. Object value of the GAttribute must have the same type as that of the type specified in AttributeType
"""if self._type == "GAttribute": data_type_in_attribute_type =
self.attribute_type['data_type'] data_type_of_object_value =
type(self.object_value) print "Attribute:: " +
str(data_type_in_attribute_type) print "Value:: " +
str(data_type_of_object_value) if data_type_in_attribute_type !=
data_type_of_object_value: raise Exception("The DataType of the
value you have entered for this attribute is not correct. Pls ener
a value with type ---> " + str(data_type_in_attribute_type))
"""
#end of data_type_check
super(Triple, self).save(*args, **kwargs)
history_manager = HistoryManager()
rcs_obj = RCS()
if is_new:
# Create history-version-file
if history_manager.create_or_replace_json_file(self):
fp = history_manager.get_file_path(self)
message = "This document (" + self.name + ") is created on " + datetime.datetime.now().strftime("%d %B %Y")
rcs_obj.checkin(fp, 1, message.encode('utf-8'), "-i")
else:
# Update history-version-file
fp = history_manager.get_file_path(self)
try:
rcs_obj.checkout(fp)
except Exception as err:
try:
if history_manager.create_or_replace_json_file(self):
fp = history_manager.get_file_path(self)
message = "This document (" + self.name + ") is re-created on " + datetime.datetime.now().strftime("%d %B %Y")
rcs_obj.checkin(fp, 1, message.encode('utf-8'), "-i")
except Exception as err:
print "\n DocumentError: This document (", self._id, ":", self.name, ") can't be re-created!!!\n"
node_collection.collection.remove({'_id': self._id})
raise RuntimeError(err)
try:
if history_manager.create_or_replace_json_file(self):
message = "This document (" + self.name + ") is lastly updated on " + datetime.datetime.now().strftime("%d %B %Y")
rcs_obj.checkin(fp, 1, message.encode('utf-8'))
except Exception as err:
print "\n DocumentError: This document (", self._id, ":", self.name, ") can't be updated!!!\n"
raise RuntimeError(err)
@connection.register
class GAttribute(Triple):
structure = {
'attribute_type_scope': basestring,
'attribute_type': AttributeType, # DBRef of AttributeType Class
'object_value_scope': basestring,
'object_value': None # value -- it's data-type, is determined by attribute_type field
}
required_fields = ['attribute_type', 'object_value']
use_dot_notation = True
use_autorefs = True # To support Embedding of Documents
@connection.register
class GRelation(Triple):
structure = {
'relation_type_scope': basestring,
'relation_type': RelationType, # DBRef of RelationType Class
'right_subject_scope': basestring,
# ObjectId's of GSystems Class / List of list of ObjectId's of GSystem Class
'right_subject': OR(ObjectId, list)
}
required_fields = ['relation_type', 'right_subject']
use_dot_notation = True
use_autorefs = True # To support Embedding of Documents
####################################### Added on 19th June 2014 for SEARCH ##############################
@connection.register
class ReducedDocs(DjangoDocument):
structure={
'_type': unicode,
'content':dict, #This contains the content in the dictionary format
'orignal_id':ObjectId, #The object ID of the orignal document
'required_for':unicode,
'is_indexed':bool, #This will be true if the map reduced document has been indexed. If it is not then it will be false
}
use_dot_notation = True
@connection.register
class ToReduceDocs(DjangoDocument):
structure={
'_type': unicode,
'doc_id':ObjectId,
'required_for':unicode,
}
use_dot_notation = True
@connection.register
class IndexedWordList(DjangoDocument):
structure={
'_type': unicode,
'word_start_id':float,
'words':dict,
'required_for':unicode,
}
use_dot_notation = True
#word_start_id = 0 --- a ,1---b,2---c .... 25---z,26--misc.
# This is like a temperory holder, where you can hold any node temporarily and later permenently save in database
@connection.register
class node_holder(DjangoDocument):
objects = models.Manager()
structure={
'_type': unicode,
'details_to_hold':dict
}
required_fields = ['details_to_hold']
use_dot_notation = True
"""
@connection.register
class allLinks(DjangoDocument):
structure = {
'member_of':ObjectId,
'link':unicode,
'required_for':unicode,
}
# required_fields = ['member_of', 'link']
use_dot_notation = True
"""
# DATABASE Variables
db = get_database()
node_collection = db[Node.collection_name].Node
triple_collection = db[Triple.collection_name].Triple
gridfs_collection = db["fs.files"]
|