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
|
"""
Note: in thoery could use, eg, https://github.com/christabor/swagger_wtforms,
but can't find one that is actually maintained.
"""
from flask_wtf import FlaskForm
from wtforms import SelectField, DateField, StringField, IntegerField, \
HiddenField, FormField, FieldList, validators
from fatcat_client import ContainerEntity, CreatorEntity, FileEntity, \
ReleaseEntity, ReleaseContrib
release_type_options = [
('', 'Unknown'),
('article-journal', 'Journal Article'),
('paper-conference', 'Conference Proceeding'),
('article', 'Article (non-journal)'),
('book', 'Book'),
('chapter', 'Book Chapter'),
('dataset', 'Dataset'),
('stub', 'Invalid/Stub'),
]
release_status_options = [
('', 'Unknown'),
('draft', 'Draft'),
('submitted', 'Submitted'),
('accepted', 'Accepted'),
('published', 'Published'),
('updated', 'Updated'),
]
role_type_options = [
('author', 'Author'),
('editor', 'Editor'),
('translator', 'Translator'),
]
class EntityEditForm(FlaskForm):
editgroup_id = StringField('Editgroup ID',
[validators.Optional(True)])
editgroup_description = StringField('Editgroup Description',
[validators.Optional(True)])
edit_description = StringField('Description of Changes',
[validators.Optional(True)])
class ReleaseContribForm(FlaskForm):
class Meta:
# this is a sub-form, so disable CSRF
csrf = False
#surname
#given_name
#creator_id (?)
#orcid (for match?)
prev_index = HiddenField('prev_revision index', default=None)
raw_name = StringField('Display Name',
[validators.DataRequired()])
role = SelectField(
[validators.DataRequired()],
choices=role_type_options,
default='author')
RELEASE_SIMPLE_ATTRS = ['title', 'original_title', 'work_id', 'container_id',
'release_type', 'release_status', 'release_date', 'doi', 'wikidata_qid',
'isbn13', 'pmid', 'pmcid', 'volume', 'issue', 'pages', 'publisher',
'language', 'license_slug']
class ReleaseEntityForm(EntityEditForm):
"""
TODO:
- field types: fatcat id
- date
"""
title = StringField('Title',
[validators.InputRequired()])
original_title = StringField('Original Title')
work_id = StringField('Work FCID')
container_id = StringField('Container FCID')
release_type = SelectField('Release Type',
[validators.DataRequired()],
choices=release_type_options,
default='')
release_status = SelectField(choices=release_status_options)
release_date = DateField('Release Date',
[validators.Optional(True)])
#release_year
doi = StringField('DOI',
[validators.Regexp('^10\..*\/.*', message="DOI must be valid"),
validators.Optional(True)])
wikidata_qid = StringField('Wikidata QID')
isbn13 = StringField('ISBN-13')
pmid = StringField('PubMed Id')
pmcid = StringField('PubMed Central Id')
#core_id
#arxiv_id
#jstor_id
volume = StringField('Volume')
issue = StringField('Issue')
pages = StringField('Pages')
publisher = StringField('Publisher (optional)')
language = StringField('Language (code)')
license_slug = StringField('License (slug)')
contribs = FieldList(FormField(ReleaseContribForm))
#refs
#abstracts
def from_entity(re):
"""
Initializes form with values from an existing release entity.
"""
ref = ReleaseEntityForm()
for simple_attr in RELEASE_SIMPLE_ATTRS:
a = getattr(ref, simple_attr)
a.data = getattr(re, simple_attr)
for i, c in enumerate(re.contribs):
rcf = ReleaseContribForm()
rcf.prev_index = i
rcf.role = c.role
rcf.raw_name = c.raw_name
ref.contribs.append_entry(rcf)
return ref
def to_entity(self):
assert(self.title.data)
entity = ReleaseEntity(title=self.title.data)
self.update_entity(entity)
return entity
def update_entity(self, re):
"""
Mutates a release entity in place, updating fields with values from
this form.
Form must be validated *before* calling this function.
"""
for simple_attr in RELEASE_SIMPLE_ATTRS:
a = getattr(self, simple_attr).data
# special case blank strings
if a == '':
a = None
setattr(re, simple_attr, a)
# bunch of complexity here to preserve old contrib metadata (eg,
# affiliation and extra) not included in current forms
# TODO: this may be broken; either way needs tests
if re.contribs:
old_contribs = re.contribs.copy()
re.contribs = []
else:
old_contribs = []
re.contribs = []
for c in self.contribs:
if c.prev_index.data not in ('', None):
rc = old_contribs[int(c.prev_index.data)]
rc.role = c.role.data or None
rc.raw_name = c.raw_name.data or None
else:
rc = ReleaseContrib(
role=c.role.data or None,
raw_name=c.raw_name.data or None,
)
re.contribs.append(rc)
if self.edit_description.data:
re.edit_extra = dict(description=self.edit_description.data)
|
