Newer
Older
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
import collections
import pyld
from rest_framework import serializers
from django.core import validators
from . import ns
_cache = {}
def document_loader(url):
loader = pyld.jsonld.requests_document_loader()
doc = ns.get_by_url(url)
if doc:
return doc
if url in _cache:
return _cache[url]
resp = loader(url)
_cache[url] = resp
return resp
def expand(document):
return pyld.jsonld.expand(document)
pyld.jsonld.set_document_loader(document_loader)
class TypeField(serializers.ListField):
def __init__(self, *args, **kwargs):
kwargs.setdefault("child", serializers.URLField())
super().__init__(*args, **kwargs)
def to_internal_value(self, value):
try:
return value[0]
except IndexError:
self.fail("invalid", value)
def to_representation(self, value):
return value
class JsonLdField(serializers.ListField):
def __init__(self, *args, **kwargs):
# by default, pyld will expand all fields to list such as
# [{"@value": "something"}]
# we may not always want this behaviour
self.single = kwargs.pop("single", False)
self.value_only = kwargs.pop("value_only", False)
self.id_only = kwargs.pop("id_only", False)
self.base_field = kwargs.pop("base_field")
super().__init__(*args, **kwargs)
if self.single:
self.validators = [
v
for v in self.validators
if not isinstance(
v, (validators.MinLengthValidator, validators.MaxLengthValidator)
)
]
def to_internal_value(self, value):
self.source_attrs = [self.field_name]
value = super().to_internal_value(value)
if self.id_only:
value = [v["@id"] for v in value]
elif self.value_only:
value = [v["@value"] for v in value]
if value and self.single:
return value[0]
return value
def to_representation(self, value):
return self.base_field.to_representation(value)
class Serializer(serializers.Serializer):
jsonld_fields = []
type_source = None
id_source = None
include_id = True
include_type = True
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
if self.include_id:
self.fields["@id"] = serializers.URLField(
required=True, **{"source": self.id_source} if self.id_source else {}
)
if self.include_type:
self.fields["@type"] = TypeField(
required=True,
**{"source": self.type_source} if self.type_source else {}
)
for field_name, field, kw in self.jsonld_fields:
self.fields[field_name] = JsonLdField(
required=field.required,
base_field=field,
min_length=1 if field.required else 0,
**kw
)
def run_validation(self, initial_data):
document = expand(initial_data)[0]
return super().run_validation(document)
def to_representation(self, data):
data = super().to_representation(data)
compacted = pyld.jsonld.compact(data, {"@context": ns.CONTEXTS})
# While compacted repr is json-ld valid, it's probably not was is
# expected by most implementations around in the fediverse,
# so we remove the semicolons completely and the prefix
return remove_semicolons(compacted)
def remove_semicolons(struct: dict, skip=["@context"]):
"""
given a JSON-LD strut such as {
'as:inbox': 'https://:test'
},
returns {
'inbox': 'https://:test'
},
"""
new_data = collections.OrderedDict()
for k, v in struct.items():
if k in skip:
new_data[k] = v
continue
parts = k.split(":")
if len(parts) > 1:
k = ":".join(parts[1:])
if isinstance(v, dict):
v = remove_semicolons(v)
elif isinstance(v, (list, tuple)):
new_v = []
for e in v:
if isinstance(e, dict):
new_v.append(remove_semicolons(e))
else:
new_v.append(e)
v = new_v
new_data[k] = v
return new_data