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 (TODO)
return eg
def editgroup_view(ident):
try:
eg = api.get_editgroup(str(ident))
eg.editor = api.get_editor(eg.editor_id)
eg.annotations = api.get_editgroup_annotations(eg.editgroup_id,
expand="editors")
except ApiException as ae:
abort(ae.status)
# TODO: idomatic check for login?
auth_to = dict(
submit=False,
accept=False,
edit=False,
annotate=False,
)
if session.get('editor'):
user = load_user(session['editor']['editor_id'])
auth_to['annotate'] = True
if user.is_admin or user.editor_id == eg.editor_id:
auth_to['submit'] = True
auth_to['edit'] = True
if user.is_admin:
auth_to['accept'] = True
return render_template('editgroup_view.html',
editgroup=eg,
auth_to=auth_to)
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:
abort(ae.status)
# check that editgroup is edit-able
if editgroup.changelog_index != None:
flash("Editgroup already merged")
abort(400)
# 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:
abort(ae.status)
return redirect("/editgroup/{}".format(editgroup_id))
def form_editgroup_get_or_create(api, edit_form):
"""
This function expects a submitted, validated
"""
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)
abort(ae.status)
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)
abort(ae.status)
# set this session editgroup_id
flash('Started new editgroup <a href="/editgroup/{}">{}</a>' \
.format(eg.editgroup_id, eg.editgroup_id))
return eg
def editgroup_view(ident):
try:
entity = api.get_editgroup(str(ident))
entity.editor = api.get_editor(entity.editor_id)
except ApiException as ae:
abort(ae.status)
return render_template('editgroup_view.html', editgroup=entity)
def generic_editgroup_entity_view(editgroup_id, entity_type, ident, view_template):
try:
editgroup = api.get_editgroup(editgroup_id)
except ApiException as ae:
abort(ae.status)
entity, edit = generic_get_editgroup_entity(editgroup, entity_type, ident)
if entity.state == "deleted":
return render_template('deleted_entity.html', entity=entity,
entity_type=entity_type, editgroup=editgroup)
metadata = entity.to_dict()
metadata.pop('extra')
entity._metadata = metadata
return render_template(view_template, entity_type=entity_type, entity=entity, editgroup=editgroup)
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:
abort(ae.status)
# check that editgroup is edit-able
if editgroup.changelog_index != None:
flash("Editgroup already merged")
abort(400)
# API on behalf of user
user_api = auth_api(session['api_token'])
# do the deletion
generic_entity_delete_edit(user_api, entity_type, editgroup.editgroup_id, edit_id)
return redirect("/editgroup/{}".format(editgroup_id))
def generic_entity_delete(editgroup_id: Optional[str], entity_type: str, existing_ident: str):
"""
Similar to generic_entity_edit(), but for deleting entities. This is a bit
simpler!
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 = EntityEditForm()
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:
# 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_delete_entity(user_api, entity_type, editgroup.editgroup_id, existing.ident)
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("entity_delete.html", form=form, entity_type=entity_type,
existing_ident=existing_ident, editgroup=editgroup,
potential_editgroups=potential_editgroups), status
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:
raise ae
# 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
