summaryrefslogtreecommitdiffstats
path: root/python/fatcat_web/editing_routes.py
blob: 9598a754b0206449cc255cfda322e18af9277db6 (plain)
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

from flask import render_template, abort, redirect, session, flash
from flask_login import login_required

from fatcat_openapi_client import *
from fatcat_openapi_client.rest import ApiException
from fatcat_tools.transforms import *
from fatcat_web import app, api, auth_api
from fatcat_web.search import *
from fatcat_web.forms import *
from fatcat_web.entity_helpers import *


### Helper Methods ##########################################################

def generic_entity_create_from_toml(user_api, entity_type: str, editgroup_id: str, toml_str: str) -> EntityEdit:
    if entity_type == 'container':
        entity = entity_from_toml(toml_str, ContainerEntity)
        edit = user_api.create_container(editgroup_id, entity)
    elif entity_type == 'creator':
        entity = entity_from_toml(toml_str, CreatorEntity)
        edit = user_api.create_creator(editgroup_id, entity)
    elif entity_type == 'file':
        entity = entity_from_toml(toml_str, FileEntity)
        edit = user_api.create_file(editgroup_id, entity)
    elif entity_type == 'fileset':
        entity = entity_from_toml(toml_str, FilesetEntity)
        edit = user_api.create_fileset(editgroup_id, entity)
    elif entity_type == 'webcapture':
        entity = entity_from_toml(toml_str, WebcaptureEntity)
        edit = user_api.create_webcapture(editgroup_id, entity)
    elif entity_type == 'release':
        entity = entity_from_toml(toml_str, ReleaseEntity)
        edit = user_api.create_release(editgroup_id, entity)
    elif entity_type == 'work':
        entity = entity_from_toml(toml_str, WorkEntity)
        edit = user_api.create_work(editgroup_id, entity)
    else:
        raise NotImplementedError
    return edit

def generic_entity_delete_edit(user_api, entity_type: str, editgroup_id: str, edit_id: str) -> None:
    try:
        if entity_type == 'container':
            user_api.delete_container_edit(editgroup_id, edit_id)
        elif entity_type == 'creator':
            user_api.delete_creator_edit(editgroup_id, edit_id)
        elif entity_type == 'file':
            user_api.delete_file_edit(editgroup_id, edit_id)
        elif entity_type == 'fileset':
            user_api.delete_fileset_edit(editgroup_id, edit_id)
        elif entity_type == 'webcapture':
            user_api.delete_webcapture_edit(editgroup_id, edit_id)
        elif entity_type == 'release':
            user_api.delete_release_edit(editgroup_id, edit_id)
        elif entity_type == 'work':
            user_api.delete_work_edit(editgroup_id, edit_id)
        else:
            raise NotImplementedError
    except ApiException as ae:
        if ae.status == 404:
            pass
        else:
            raise ae

def generic_entity_update_from_toml(user_api, entity_type: str, editgroup_id: str, existing_ident, toml_str: str) -> EntityEdit:
    if entity_type == 'container':
        entity = entity_from_toml(toml_str, ContainerEntity)
        edit = user_api.update_container(editgroup_id, existing_ident, entity)
    elif entity_type == 'creator':
        entity = entity_from_toml(toml_str, CreatorEntity)
        edit = user_api.update_creator(editgroup_id, existing_ident, entity)
    elif entity_type == 'file':
        entity = entity_from_toml(toml_str, FileEntity)
        edit = user_api.update_file(editgroup_id, existing_ident, entity)
    elif entity_type == 'fileset':
        entity = entity_from_toml(toml_str, FilesetEntity)
        edit = user_api.update_fileset(editgroup_id, existing_ident, entity)
    elif entity_type == 'webcapture':
        entity = entity_from_toml(toml_str, WebcaptureEntity)
        edit = user_api.update_webcapture(editgroup_id, existing_ident, entity)
    elif entity_type == 'release':
        entity = entity_from_toml(toml_str, ReleaseEntity)
        edit = user_api.update_release(editgroup_id, existing_ident, entity)
    elif entity_type == 'work':
        entity = entity_from_toml(toml_str, WorkEntity)
        edit = user_api.update_work(editgroup_id, existing_ident, entity)
    else:
        raise NotImplementedError
    return edit

def form_editgroup_get_or_create(api, edit_form):
    """
    This function expects a submitted, validated edit form
    """
    if edit_form.editgroup_id.data:
        try:
            eg = api.get_editgroup(edit_form.editgroup_id.data)
        except ApiException as ae:
            if ae.status == 404:
                edit_form.editgroup_id.errors.append("Editgroup does not exist")
                return None
            app.log.warning(ae)
            raise ae
        if eg.changelog_index:
            edit_form.editgroup_id.errors.append("Editgroup has already been accepted")
            return None
    else:
        # if no editgroup, create one from description
        try:
            eg = api.create_editgroup(
                Editgroup(description=edit_form.editgroup_description.data or None))
        except ApiException as ae:
            app.log.warning(ae)
            raise ae
        # set this session editgroup_id
        flash('Started new editgroup <a href="/editgroup/{}">{}</a>'.format(
            eg.editgroup_id,
            eg.editgroup_id,
        ))
    return eg

def generic_entity_edit(editgroup_id, entity_type, existing_ident, edit_template):
    """

    existing (entity)

    Create: existing blank, ident blank, editgroup optional
    Update: ident set

    Need to handle:
    - editgroup not set (need to create one)
    - creating entity from form
    - updating an existing ident
    - updating an existing editgroup/ident

    Views:
    - /container/create
    - /container/<ident>/edit
    - /editgroup/<editgroup_id>/container/<ident>/edit

    Helpers:
    - get_editgroup_revision(editgroup, entity_type, ident) -> None or entity

    TODO: prev_rev interlock
    """

    # fetch editgroup (if set) or 404
    editgroup = None
    if editgroup_id:
        try:
            editgroup = api.get_editgroup(editgroup_id)
        except ApiException as ae:
            abort(ae.status)

        # check that editgroup is edit-able
        if editgroup.changelog_index != None:
            abort(400, "Editgroup already merged")

    # fetch entity (if set) or 404
    existing = None
    existing_edit = None
    if editgroup and existing_ident:
        existing, existing_edit = generic_get_editgroup_entity(editgroup, entity_type, existing_ident)
    elif existing_ident:
        existing = generic_get_entity(entity_type, existing_ident)

    # parse form (if submitted)
    status = 200
    if entity_type == 'container':
        form = ContainerEntityForm()
    elif entity_type == 'file':
        form = FileEntityForm()
    elif entity_type == 'release':
        form = ReleaseEntityForm()
    else:
        raise NotImplementedError

    if form.is_submitted():
        if form.validate_on_submit():
            # API on behalf of user
            user_api = auth_api(session['api_token'])
            if not editgroup:
                editgroup = form_editgroup_get_or_create(user_api, form)

            if editgroup:

                if not existing_ident: # it's a create
                    entity = form.to_entity()
                    try:
                        if entity_type == 'container':
                            edit = user_api.create_container(editgroup.editgroup_id, entity)
                        elif entity_type == 'file':
                            edit = user_api.create_file(editgroup.editgroup_id, entity)
                        elif entity_type == 'release':
                            edit = user_api.create_release(editgroup.editgroup_id, entity)
                        else:
                            raise NotImplementedError
                    except ApiException as ae:
                        app.log.warning(ae)
                        raise ae
                    return redirect('/editgroup/{}/{}/{}'.format(editgroup.editgroup_id, entity_type, edit.ident))
                else: # it's an update
                    # all the tricky logic is in the update method
                    form.update_entity(existing)
                    # do we need to try to delete the current in-progress edit first?
                    # TODO: some danger of wiping database state here is
                    # "updated edit" causes, eg, a 4xx error. Better to allow
                    # this in the API itself. For now, form validation *should*
                    # catch most errors, and if not editor can hit back and try
                    # again. This means, need to allow failure of deletion.
                    if existing_edit:
                        # need to clear revision on object or this becomes just
                        # a "update pointer" edit
                        existing.revision = None
                        try:
                            generic_entity_delete_edit(user_api, entity_type, editgroup.editgroup_id, existing_edit.edit_id)
                        except ApiException as ae:
                            if ae.status == 404:
                                pass
                            else:
                                raise ae
                    try:
                        if entity_type == 'container':
                            edit = user_api.update_container(editgroup.editgroup_id, existing.ident, existing)
                        elif entity_type == 'file':
                            edit = user_api.update_file(editgroup.editgroup_id, existing.ident, existing)
                        elif entity_type == 'release':
                            edit = user_api.update_release(editgroup.editgroup_id, existing.ident, existing)
                        else:
                            raise NotImplementedError
                    except ApiException as ae:
                        app.log.warning(ae)
                        raise ae
                    return redirect('/editgroup/{}/{}/{}'.format(editgroup.editgroup_id, entity_type, edit.ident))
            else:
                status = 400
        elif form.errors:
            status = 400
            app.log.info("form errors (did not validate): {}".format(form.errors))

    else: # form is not submitted
        if existing:
            if entity_type == 'container':
                form = ContainerEntityForm.from_entity(existing)
            elif entity_type == 'file':
                form = FileEntityForm.from_entity(existing)
            elif entity_type == 'release':
                form = ReleaseEntityForm.from_entity(existing)
            else:
                raise NotImplementedError

    editor_editgroups = api.get_editor_editgroups(session['editor']['editor_id'], limit=20)
    potential_editgroups = [e for e in editor_editgroups if e.changelog_index == None and e.submitted == None]

    if not form.is_submitted():
        # default to most recent not submitted, fallback to "create new"
        form.editgroup_id.data = ""
        if potential_editgroups:
            form.editgroup_id.data = potential_editgroups[0].editgroup_id

    return render_template(edit_template, form=form,
        existing_ident=existing_ident, editgroup=editgroup,
        potential_editgroups=potential_editgroups), status

def generic_entity_toml_edit(editgroup_id, entity_type, existing_ident, edit_template):
    """
    Similar to generic_entity_edit(), but for TOML editing mode.

    Handles both creation and update/edit paths.
    """

    # fetch editgroup (if set) or 404
    editgroup = None
    if editgroup_id:
        try:
            editgroup = api.get_editgroup(editgroup_id)
        except ApiException as ae:
            raise ae

        # check that editgroup is edit-able
        if editgroup.changelog_index != None:
            flash("Editgroup already merged")
            abort(400)

    # fetch entity (if set) or 404
    existing = None
    existing_edit = None
    if editgroup and existing_ident:
        existing, existing_edit = generic_get_editgroup_entity(editgroup, entity_type, existing_ident)
    elif existing_ident:
        existing = generic_get_entity(entity_type, existing_ident)

    # parse form (if submitted)
    status = 200
    form = EntityTomlForm()

    if form.is_submitted():
        if form.validate_on_submit():
            # API on behalf of user
            user_api = auth_api(session['api_token'])
            if not editgroup:
                editgroup = form_editgroup_get_or_create(user_api, form)

            if editgroup:

                if not existing_ident: # it's a create
                    try:
                        edit = generic_entity_create_from_toml(user_api, entity_type, editgroup.editgroup_id, form.toml.data)
                    except ValueError as ve:
                        form.toml.errors = [ve]
                        status = 400
                    except ApiException as ae:
                        app.log.warning(ae)
                        raise ae
                    if status == 200:
                        return redirect('/editgroup/{}/{}/{}'.format(editgroup.editgroup_id, entity_type, edit.ident))
                else: # it's an update
                    # TODO: some danger of wiping database state here is
                    # "updated edit" causes, eg, a 4xx error. Better to allow
                    # this in the API itself. For now, form validation *should*
                    # catch most errors, and if not editor can hit back and try
                    # again. This means, need to allow failure of deletion.
                    if existing_edit:
                        # need to clear revision on object or this becomes just
                        # a "update pointer" edit
                        existing.revision = None
                        generic_entity_delete_edit(user_api, entity_type, editgroup.editgroup_id, existing_edit.edit_id)
                    try:
                        edit = generic_entity_update_from_toml(user_api, entity_type, editgroup.editgroup_id, existing.ident, form.toml.data)
                    except ValueError as ve:
                        form.toml.errors = [ve]
                        status = 400
                    except ApiException as ae:
                        app.log.warning(ae)
                        raise ae
                    if status == 200:
                        return redirect('/editgroup/{}/{}/{}'.format(editgroup.editgroup_id, entity_type, edit.ident))
            else:
                status = 400
        elif form.errors:
            status = 400
            app.log.info("form errors (did not validate): {}".format(form.errors))

    else: # form is not submitted
        if existing:
            form = EntityTomlForm.from_entity(existing)

    editor_editgroups = api.get_editor_editgroups(session['editor']['editor_id'], limit=20)
    potential_editgroups = [e for e in editor_editgroups if e.changelog_index == None and e.submitted == None]

    if not form.is_submitted():
        # default to most recent not submitted, fallback to "create new"
        form.editgroup_id.data = ""
        if potential_editgroups:
            form.editgroup_id.data = potential_editgroups[0].editgroup_id

    return render_template(edit_template, form=form, entity_type=entity_type,
        existing_ident=existing_ident, editgroup=editgroup,
        potential_editgroups=potential_editgroups), status

def generic_edit_delete(editgroup_id, entity_type, edit_id):
    # fetch editgroup (if set) or 404
    editgroup = None
    if editgroup_id:
        try:
            editgroup = api.get_editgroup(editgroup_id)
        except ApiException as ae:
            raise ae

        # check that editgroup is edit-able
        if editgroup.changelog_index != None:
            abort(400, "Editgroup already merged")

    # API on behalf of user
    user_api = auth_api(session['api_token'])

    # do the deletion
    try:
        if entity_type == 'container':
            user_api.delete_container_edit(editgroup.editgroup_id, edit_id)
        elif entity_type == 'file':
            user_api.delete_file_edit(editgroup.editgroup_id, edit_id)
        elif entity_type == 'release':
            user_api.delete_release_edit(editgroup.editgroup_id, edit_id)
        else:
            raise NotImplementedError
    except ApiException as ae:
        raise ae
    return redirect("/editgroup/{}".format(editgroup_id))


### Views ###################################################################

@app.route('/container/create', methods=['GET', 'POST'])
@login_required
def container_create_view():
    return generic_entity_edit(None, 'container', None, 'container_create.html')

@app.route('/container/<ident>/edit', methods=['GET', 'POST'])
@login_required
def container_edit(ident):
    return generic_entity_edit(None, 'container', ident, 'container_edit.html')

@app.route('/editgroup/<editgroup_id>/container/<ident>/edit', methods=['GET', 'POST'])
@login_required
def container_editgroup_edit(editgroup_id, ident):
    return generic_entity_edit(editgroup_id, 'container', ident, 'container_edit.html')

@app.route('/editgroup/<editgroup_id>/container/edit/<edit_id>/delete', methods=['POST'])
@login_required
def container_edit_delete(editgroup_id, edit_id):
    return generic_edit_delete(editgroup_id, 'container', edit_id)

@app.route('/file/create', methods=['GET', 'POST'])
@login_required
def file_create_view():
    return generic_entity_edit(None, 'file', None, 'file_create.html')

@app.route('/file/<ident>/edit', methods=['GET', 'POST'])
@login_required
def file_edit(ident):
    return generic_entity_edit(None, 'file', ident, 'file_edit.html')

@app.route('/editgroup/<editgroup_id>/file/<ident>/edit', methods=['GET', 'POST'])
@login_required
def file_editgroup_edit(editgroup_id, ident):
    return generic_entity_edit(editgroup_id, 'file', ident, 'file_edit.html')

@app.route('/editgroup/<editgroup_id>/file/edit/<edit_id>/delete', methods=['POST'])
@login_required
def file_edit_delete(editgroup_id, edit_id):
    return generic_edit_delete(editgroup_id, 'file', edit_id)

@app.route('/release/create', methods=['GET', 'POST'])
@login_required
def release_create_view():
    return generic_entity_edit(None, 'release', None, 'release_create.html')

@app.route('/release/<ident>/edit', methods=['GET', 'POST'])
@login_required
def release_edit(ident):
    return generic_entity_edit(None, 'release', ident, 'release_edit.html')

@app.route('/editgroup/<editgroup_id>/release/<ident>/edit', methods=['GET', 'POST'])
@login_required
def release_editgroup_edit(editgroup_id, ident):
    return generic_entity_edit(editgroup_id, 'release', ident, 'release_edit.html')

@app.route('/editgroup/<editgroup_id>/release/edit/<edit_id>/delete', methods=['POST'])
@login_required
def release_edit_delete(editgroup_id, edit_id):
    return generic_edit_delete(editgroup_id, 'release', edit_id)


### Not-Implemented Views ###################################################

@app.route('/creator/create', methods=['GET'])
def creator_create_view():
    return abort(404)

@app.route('/creator/<ident>/edit', methods=['GET'])
def creator_edit(ident):
    return render_template('entity_edit.html'), 404

@app.route('/editgroup/<editgroup_id>/creator/<ident>/edit', methods=['GET', 'POST'])
def creator_editgroup_edit(editgroup_id, ident):
    return abort(404)

@app.route('/editgroup/<editgroup_id>/creator/edit/<edit_id>/delete', methods=['POST'])
def creator_edit_delete(editgroup_id, edit_id):
    return abort(404)

@app.route('/fileset/create', methods=['GET'])
def fileset_create_view():
    return abort(404)

@app.route('/fileset/<ident>/edit', methods=['GET'])
def fileset_edit(ident):
    return render_template('entity_edit.html'), 404

@app.route('/editgroup/<editgroup_id>/fileset/<ident>/edit', methods=['GET', 'POST'])
def fileset_editgroup_edit(editgroup_id, ident):
    return abort(404)

@app.route('/editgroup/<editgroup_id>/fileset/edit/<edit_id>/delete', methods=['POST'])
def fileset_edit_delete(editgroup_id, edit_id):
    return abort(404)

@app.route('/webcapture/create', methods=['GET'])
def webcapture_create_view():
    return abort(404)

@app.route('/webcapture/<ident>/edit', methods=['GET'])
def webcapture_edit(ident):
    return render_template('entity_edit.html'), 404

@app.route('/editgroup/<editgroup_id>/webcapture/<ident>/edit', methods=['GET', 'POST'])
def webcapture_editgroup_edit(editgroup_id, ident):
    return abort(404)

@app.route('/editgroup/<editgroup_id>/webcapture/edit/<edit_id>/delete', methods=['POST'])
def webcapture_edit_delete(editgroup_id, edit_id):
    return abort(404)

@app.route('/work/create', methods=['GET'])
def work_create_view():
    return abort(404)

@app.route('/work/<ident>/edit', methods=['GET'])
def work_edit(ident):
    return render_template('entity_edit.html'), 404

@app.route('/editgroup/<editgroup_id>/work/<ident>/edit', methods=['GET', 'POST'])
def work_editgroup_edit(editgroup_id, ident):
    return abort(404)

@app.route('/editgroup/<editgroup_id>/work/edit/<edit_id>/delete', methods=['POST'])
def work_edit_delete(editgroup_id, edit_id):
    return abort(404)