summaryrefslogtreecommitdiffstats
path: root/python/fatcat_web/routes.py
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2021-11-02 18:14:43 -0700
committerBryan Newbold <bnewbold@robocracy.org>2021-11-02 18:14:43 -0700
commit9dc891b8098542bb089c8c47098b60a8beb76a53 (patch)
tree2c9b1c569b6b9bb4041ef51076d024b6980089c5 /python/fatcat_web/routes.py
parent6464631dbe5c4afeb76f2f3c9d63b89f917c9a3b (diff)
downloadfatcat-9dc891b8098542bb089c8c47098b60a8beb76a53.tar.gz
fatcat-9dc891b8098542bb089c8c47098b60a8beb76a53.zip
fmt (black): fatcat_web/
Diffstat (limited to 'python/fatcat_web/routes.py')
-rw-r--r--python/fatcat_web/routes.py1003
1 files changed, 619 insertions, 384 deletions
diff --git a/python/fatcat_web/routes.py b/python/fatcat_web/routes.py
index fc94da66..e6963dbc 100644
--- a/python/fatcat_web/routes.py
+++ b/python/fatcat_web/routes.py
@@ -1,4 +1,3 @@
-
import json
import os
@@ -72,7 +71,8 @@ from fatcat_web.search import (
### Generic Entity Views ####################################################
-@app.route('/container/<string(length=26):ident>/history', methods=['GET'])
+
+@app.route("/container/<string(length=26):ident>/history", methods=["GET"])
def container_history(ident):
try:
entity = api.get_container(ident)
@@ -80,82 +80,82 @@ def container_history(ident):
except ApiException as ae:
app.log.info(ae)
abort(ae.status)
- return render_template('entity_history.html',
- entity_type="container",
- entity=entity,
- history=history)
+ return render_template(
+ "entity_history.html", entity_type="container", entity=entity, history=history
+ )
-@app.route('/creator/<string(length=26):ident>/history', methods=['GET'])
+
+@app.route("/creator/<string(length=26):ident>/history", methods=["GET"])
def creator_history(ident):
try:
entity = api.get_creator(ident)
history = api.get_creator_history(ident)
except ApiException as ae:
abort(ae.status)
- return render_template('entity_history.html',
- entity_type="creator",
- entity=entity,
- history=history)
+ return render_template(
+ "entity_history.html", entity_type="creator", entity=entity, history=history
+ )
-@app.route('/file/<string(length=26):ident>/history', methods=['GET'])
+
+@app.route("/file/<string(length=26):ident>/history", methods=["GET"])
def file_history(ident):
try:
entity = api.get_file(ident)
history = api.get_file_history(ident)
except ApiException as ae:
abort(ae.status)
- return render_template('entity_history.html',
- entity_type="file",
- entity=entity,
- history=history)
+ return render_template(
+ "entity_history.html", entity_type="file", entity=entity, history=history
+ )
-@app.route('/fileset/<string(length=26):ident>/history', methods=['GET'])
+
+@app.route("/fileset/<string(length=26):ident>/history", methods=["GET"])
def fileset_history(ident):
try:
entity = api.get_fileset(ident)
history = api.get_fileset_history(ident)
except ApiException as ae:
abort(ae.status)
- return render_template('entity_history.html',
- entity_type="fileset",
- entity=entity,
- history=history)
+ return render_template(
+ "entity_history.html", entity_type="fileset", entity=entity, history=history
+ )
-@app.route('/webcapture/<string(length=26):ident>/history', methods=['GET'])
+
+@app.route("/webcapture/<string(length=26):ident>/history", methods=["GET"])
def webcapture_history(ident):
try:
entity = api.get_webcapture(ident)
history = api.get_webcapture_history(ident)
except ApiException as ae:
abort(ae.status)
- return render_template('entity_history.html',
- entity_type="webcapture",
- entity=entity,
- history=history)
+ return render_template(
+ "entity_history.html", entity_type="webcapture", entity=entity, history=history
+ )
+
-@app.route('/release/<string(length=26):ident>/history', methods=['GET'])
+@app.route("/release/<string(length=26):ident>/history", methods=["GET"])
def release_history(ident):
try:
entity = api.get_release(ident)
history = api.get_release_history(ident)
except ApiException as ae:
abort(ae.status)
- return render_template('entity_history.html',
- entity_type="release",
- entity=entity,
- history=history)
+ return render_template(
+ "entity_history.html", entity_type="release", entity=entity, history=history
+ )
+
-@app.route('/work/<string(length=26):ident>/history', methods=['GET'])
+@app.route("/work/<string(length=26):ident>/history", methods=["GET"])
def work_history(ident):
try:
entity = api.get_work(ident)
history = api.get_work_history(ident)
except ApiException as ae:
abort(ae.status)
- return render_template('entity_history.html',
- entity_type="work",
- entity=entity,
- history=history)
+ return render_template(
+ "entity_history.html", entity_type="work", entity=entity, history=history
+ )
+
def generic_lookup_view(entity_type, lookup_template, extid_types, lookup_lambda):
extid = None
@@ -172,81 +172,106 @@ def generic_lookup_view(entity_type, lookup_template, extid_types, lookup_lambda
resp = lookup_lambda({extid: extid_value})
except ValueError:
return make_response(
- render_template(lookup_template,
- lookup_key=extid,
- lookup_value=extid_value,
- lookup_error=400),
- 400)
+ render_template(
+ lookup_template, lookup_key=extid, lookup_value=extid_value, lookup_error=400
+ ),
+ 400,
+ )
except ApiException as ae:
if ae.status == 404 or ae.status == 400:
return make_response(
- render_template(lookup_template,
+ render_template(
+ lookup_template,
lookup_key=extid,
lookup_value=extid_value,
- lookup_error=ae.status),
- ae.status)
+ lookup_error=ae.status,
+ ),
+ ae.status,
+ )
else:
app.log.info(ae)
raise ae
- return redirect('/{}/{}'.format(entity_type, resp.ident))
+ return redirect("/{}/{}".format(entity_type, resp.ident))
+
-@app.route('/container/lookup', methods=['GET'])
+@app.route("/container/lookup", methods=["GET"])
def container_lookup():
return generic_lookup_view(
- 'container',
- 'container_lookup.html',
- ('issn', 'issne', 'issnp', 'issnl', 'wikidata_qid'),
- lambda p: api.lookup_container(**p))
+ "container",
+ "container_lookup.html",
+ ("issn", "issne", "issnp", "issnl", "wikidata_qid"),
+ lambda p: api.lookup_container(**p),
+ )
-@app.route('/creator/lookup', methods=['GET'])
+
+@app.route("/creator/lookup", methods=["GET"])
def creator_lookup():
return generic_lookup_view(
- 'creator',
- 'creator_lookup.html',
- ('orcid', 'wikidata_qid'),
- lambda p: api.lookup_creator(**p))
+ "creator",
+ "creator_lookup.html",
+ ("orcid", "wikidata_qid"),
+ lambda p: api.lookup_creator(**p),
+ )
-@app.route('/file/lookup', methods=['GET'])
+
+@app.route("/file/lookup", methods=["GET"])
def file_lookup():
return generic_lookup_view(
- 'file',
- 'file_lookup.html',
- ('md5', 'sha1', 'sha256'),
- lambda p: api.lookup_file(**p))
+ "file", "file_lookup.html", ("md5", "sha1", "sha256"), lambda p: api.lookup_file(**p)
+ )
-@app.route('/fileset/lookup', methods=['GET'])
+
+@app.route("/fileset/lookup", methods=["GET"])
def fileset_lookup():
abort(404)
-@app.route('/webcapture/lookup', methods=['GET'])
+
+@app.route("/webcapture/lookup", methods=["GET"])
def webcapture_lookup():
abort(404)
-@app.route('/release/lookup', methods=['GET'])
+
+@app.route("/release/lookup", methods=["GET"])
def release_lookup():
return generic_lookup_view(
- 'release',
- 'release_lookup.html',
- ('doi', 'wikidata_qid', 'pmid', 'pmcid', 'isbn13', 'jstor', 'arxiv',
- 'core', 'ark', 'mag', 'oai', 'hdl'),
- lambda p: api.lookup_release(**p))
+ "release",
+ "release_lookup.html",
+ (
+ "doi",
+ "wikidata_qid",
+ "pmid",
+ "pmcid",
+ "isbn13",
+ "jstor",
+ "arxiv",
+ "core",
+ "ark",
+ "mag",
+ "oai",
+ "hdl",
+ ),
+ lambda p: api.lookup_release(**p),
+ )
+
-@app.route('/work/lookup', methods=['GET'])
+@app.route("/work/lookup", methods=["GET"])
def work_lookup():
abort(404)
+
### More Generic Entity Views ###############################################
+
def generic_entity_view(entity_type, ident, view_template):
entity = generic_get_entity(entity_type, ident)
if entity.state == "redirect":
- return redirect('/{}/{}'.format(entity_type, entity.redirect))
+ return redirect("/{}/{}".format(entity_type, entity.redirect))
elif entity.state == "deleted":
- return render_template('deleted_entity.html', entity_type=entity_type, entity=entity)
+ return render_template("deleted_entity.html", entity_type=entity_type, entity=entity)
metadata = entity.to_dict()
- metadata.pop('extra')
+ metadata.pop("extra")
entity._metadata = metadata
if view_template == "container_view.html":
@@ -258,16 +283,22 @@ def generic_entity_view(entity_type, ident, view_template):
ReleaseQuery(container_id=ident),
)
- return render_template(view_template, entity_type=entity_type, entity=entity, editgroup_id=None)
+ return render_template(
+ view_template, entity_type=entity_type, entity=entity, editgroup_id=None
+ )
+
def generic_entity_revision_view(entity_type, revision_id, view_template):
entity = generic_get_entity_revision(entity_type, revision_id)
metadata = entity.to_dict()
- metadata.pop('extra')
+ metadata.pop("extra")
entity._metadata = metadata
- return render_template(view_template, entity_type=entity_type, entity=entity, editgroup_id=None)
+ return render_template(
+ view_template, entity_type=entity_type, entity=entity, editgroup_id=None
+ )
+
def generic_editgroup_entity_view(editgroup_id, entity_type, ident, view_template):
try:
@@ -278,251 +309,354 @@ def generic_editgroup_entity_view(editgroup_id, entity_type, ident, view_templat
entity, edit = generic_get_editgroup_entity(editgroup, entity_type, ident)
if entity.revision is None or entity.state == "deleted":
- return render_template('deleted_entity.html', entity=entity,
- entity_type=entity_type, editgroup=editgroup)
+ return render_template(
+ "deleted_entity.html", entity=entity, entity_type=entity_type, editgroup=editgroup
+ )
metadata = entity.to_dict()
- metadata.pop('extra')
+ metadata.pop("extra")
entity._metadata = metadata
- return render_template(view_template, entity_type=entity_type, entity=entity, editgroup=editgroup)
+ return render_template(
+ view_template, entity_type=entity_type, entity=entity, editgroup=editgroup
+ )
-@app.route('/container/<string(length=26):ident>', methods=['GET'])
+@app.route("/container/<string(length=26):ident>", methods=["GET"])
def container_view(ident):
- return generic_entity_view('container', ident, 'container_view.html')
+ return generic_entity_view("container", ident, "container_view.html")
+
-@app.route('/container_<string(length=26):ident>', methods=['GET'])
+@app.route("/container_<string(length=26):ident>", methods=["GET"])
def container_underscore_view(ident):
- return redirect('/container/{}'.format(ident))
+ return redirect("/container/{}".format(ident))
-@app.route('/container/<string(length=26):ident>/coverage', methods=['GET'])
+
+@app.route("/container/<string(length=26):ident>/coverage", methods=["GET"])
def container_view_coverage(ident):
# note: there is a special hack to add entity._type_preservation for this endpoint
- return generic_entity_view('container', ident, 'container_view_coverage.html')
+ return generic_entity_view("container", ident, "container_view_coverage.html")
+
-@app.route('/container/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/container/<string(length=26):ident>/metadata", methods=["GET"])
def container_view_metadata(ident):
- return generic_entity_view('container', ident, 'entity_view_metadata.html')
+ return generic_entity_view("container", ident, "entity_view_metadata.html")
+
-@app.route('/container/rev/<uuid:revision_id>', methods=['GET'])
+@app.route("/container/rev/<uuid:revision_id>", methods=["GET"])
def container_revision_view(revision_id):
- return generic_entity_revision_view('container', str(revision_id), 'container_view.html')
+ return generic_entity_revision_view("container", str(revision_id), "container_view.html")
-@app.route('/container/rev/<uuid:revision_id>/metadata', methods=['GET'])
+
+@app.route("/container/rev/<uuid:revision_id>/metadata", methods=["GET"])
def container_revision_view_metadata(revision_id):
- return generic_entity_revision_view('container', str(revision_id), 'entity_view_metadata.html')
+ return generic_entity_revision_view(
+ "container", str(revision_id), "entity_view_metadata.html"
+ )
-@app.route('/editgroup/<editgroup_id>/container/<string(length=26):ident>', methods=['GET'])
+
+@app.route("/editgroup/<editgroup_id>/container/<string(length=26):ident>", methods=["GET"])
def container_editgroup_view(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'container', ident, 'container_view.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "container", ident, "container_view.html"
+ )
-@app.route('/editgroup/<editgroup_id>/container/<string(length=26):ident>/metadata', methods=['GET'])
+
+@app.route(
+ "/editgroup/<editgroup_id>/container/<string(length=26):ident>/metadata", methods=["GET"]
+)
def container_editgroup_view_metadata(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'container', ident, 'entity_view_metadata.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "container", ident, "entity_view_metadata.html"
+ )
-@app.route('/creator/<string(length=26):ident>', methods=['GET'])
+@app.route("/creator/<string(length=26):ident>", methods=["GET"])
def creator_view(ident):
- return generic_entity_view('creator', ident, 'creator_view.html')
+ return generic_entity_view("creator", ident, "creator_view.html")
-@app.route('/creator_<string(length=26):ident>', methods=['GET'])
+
+@app.route("/creator_<string(length=26):ident>", methods=["GET"])
def creator_underscore_view(ident):
- return redirect('/creator/{}'.format(ident))
+ return redirect("/creator/{}".format(ident))
+
-@app.route('/creator/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/creator/<string(length=26):ident>/metadata", methods=["GET"])
def creator_view_metadata(ident):
- return generic_entity_view('creator', ident, 'entity_view_metadata.html')
+ return generic_entity_view("creator", ident, "entity_view_metadata.html")
+
-@app.route('/creator/rev/<uuid:revision_id>', methods=['GET'])
+@app.route("/creator/rev/<uuid:revision_id>", methods=["GET"])
def creator_revision_view(revision_id):
- return generic_entity_revision_view('creator', str(revision_id), 'creator_view.html')
+ return generic_entity_revision_view("creator", str(revision_id), "creator_view.html")
-@app.route('/creator/rev/<uuid:revision_id>/metadata', methods=['GET'])
+
+@app.route("/creator/rev/<uuid:revision_id>/metadata", methods=["GET"])
def creator_revision_view_metadata(revision_id):
- return generic_entity_revision_view('creator', str(revision_id), 'entity_view_metadata.html')
+ return generic_entity_revision_view(
+ "creator", str(revision_id), "entity_view_metadata.html"
+ )
+
-@app.route('/editgroup/<editgroup_id>/creator/<string(length=26):ident>', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/creator/<string(length=26):ident>", methods=["GET"])
def creator_editgroup_view(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'creator', ident, 'creator_view.html')
+ return generic_editgroup_entity_view(editgroup_id, "creator", ident, "creator_view.html")
-@app.route('/editgroup/<editgroup_id>/creator/<string(length=26):ident>/metadata', methods=['GET'])
+
+@app.route(
+ "/editgroup/<editgroup_id>/creator/<string(length=26):ident>/metadata", methods=["GET"]
+)
def creator_editgroup_view_metadata(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'creator', ident, 'entity_view_metadata.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "creator", ident, "entity_view_metadata.html"
+ )
-@app.route('/file/<string(length=26):ident>', methods=['GET'])
+@app.route("/file/<string(length=26):ident>", methods=["GET"])
def file_view(ident):
- return generic_entity_view('file', ident, 'file_view.html')
+ return generic_entity_view("file", ident, "file_view.html")
-@app.route('/file_<string(length=26):ident>', methods=['GET'])
+
+@app.route("/file_<string(length=26):ident>", methods=["GET"])
def file_underscore_view(ident):
- return redirect('/file/{}'.format(ident))
+ return redirect("/file/{}".format(ident))
+
-@app.route('/file/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/file/<string(length=26):ident>/metadata", methods=["GET"])
def file_view_metadata(ident):
- return generic_entity_view('file', ident, 'entity_view_metadata.html')
+ return generic_entity_view("file", ident, "entity_view_metadata.html")
+
-@app.route('/file/rev/<uuid:revision_id>', methods=['GET'])
+@app.route("/file/rev/<uuid:revision_id>", methods=["GET"])
def file_revision_view(revision_id):
- return generic_entity_revision_view('file', str(revision_id), 'file_view.html')
+ return generic_entity_revision_view("file", str(revision_id), "file_view.html")
-@app.route('/file/rev/<uuid:revision_id>/metadata', methods=['GET'])
+
+@app.route("/file/rev/<uuid:revision_id>/metadata", methods=["GET"])
def file_revision_view_metadata(revision_id):
- return generic_entity_revision_view('file', str(revision_id), 'entity_view_metadata.html')
+ return generic_entity_revision_view("file", str(revision_id), "entity_view_metadata.html")
+
-@app.route('/editgroup/<editgroup_id>/file/<string(length=26):ident>', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/file/<string(length=26):ident>", methods=["GET"])
def file_editgroup_view(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'file', ident, 'file_view.html')
+ return generic_editgroup_entity_view(editgroup_id, "file", ident, "file_view.html")
+
-@app.route('/editgroup/<editgroup_id>/file/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/file/<string(length=26):ident>/metadata", methods=["GET"])
def file_editgroup_view_metadata(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'file', ident, 'entity_view_metadata.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "file", ident, "entity_view_metadata.html"
+ )
-@app.route('/fileset/<string(length=26):ident>', methods=['GET'])
+@app.route("/fileset/<string(length=26):ident>", methods=["GET"])
def fileset_view(ident):
- return generic_entity_view('fileset', ident, 'fileset_view.html')
+ return generic_entity_view("fileset", ident, "fileset_view.html")
+
-@app.route('/fileset_<string(length=26):ident>', methods=['GET'])
+@app.route("/fileset_<string(length=26):ident>", methods=["GET"])
def fileset_underscore_view(ident):
- return redirect('/fileset/{}'.format(ident))
+ return redirect("/fileset/{}".format(ident))
+
-@app.route('/fileset/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/fileset/<string(length=26):ident>/metadata", methods=["GET"])
def fileset_view_metadata(ident):
- return generic_entity_view('fileset', ident, 'entity_view_metadata.html')
+ return generic_entity_view("fileset", ident, "entity_view_metadata.html")
-@app.route('/fileset/rev/<uuid:revision_id>', methods=['GET'])
+
+@app.route("/fileset/rev/<uuid:revision_id>", methods=["GET"])
def fileset_revision_view(revision_id):
- return generic_entity_revision_view('fileset', str(revision_id), 'fileset_view.html')
+ return generic_entity_revision_view("fileset", str(revision_id), "fileset_view.html")
+
-@app.route('/fileset/rev/<uuid:revision_id>/metadata', methods=['GET'])
+@app.route("/fileset/rev/<uuid:revision_id>/metadata", methods=["GET"])
def fileset_revision_view_metadata(revision_id):
- return generic_entity_revision_view('fileset', str(revision_id), 'entity_view_metadata.html')
+ return generic_entity_revision_view(
+ "fileset", str(revision_id), "entity_view_metadata.html"
+ )
+
-@app.route('/editgroup/<editgroup_id>/fileset/<string(length=26):ident>', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/fileset/<string(length=26):ident>", methods=["GET"])
def fileset_editgroup_view(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'fileset', ident, 'fileset_view.html')
+ return generic_editgroup_entity_view(editgroup_id, "fileset", ident, "fileset_view.html")
-@app.route('/editgroup/<editgroup_id>/fileset/<string(length=26):ident>/metadata', methods=['GET'])
+
+@app.route(
+ "/editgroup/<editgroup_id>/fileset/<string(length=26):ident>/metadata", methods=["GET"]
+)
def fileset_editgroup_view_metadata(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'fileset', ident, 'entity_view_metadata.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "fileset", ident, "entity_view_metadata.html"
+ )
-@app.route('/webcapture/<string(length=26):ident>', methods=['GET'])
+@app.route("/webcapture/<string(length=26):ident>", methods=["GET"])
def webcapture_view(ident):
- return generic_entity_view('webcapture', ident, 'webcapture_view.html')
+ return generic_entity_view("webcapture", ident, "webcapture_view.html")
-@app.route('/webcapture_<string(length=26):ident>', methods=['GET'])
+
+@app.route("/webcapture_<string(length=26):ident>", methods=["GET"])
def webcapture_underscore_view(ident):
- return redirect('/webcapture/{}'.format(ident))
+ return redirect("/webcapture/{}".format(ident))
+
-@app.route('/webcapture/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/webcapture/<string(length=26):ident>/metadata", methods=["GET"])
def webcapture_view_metadata(ident):
- return generic_entity_view('webcapture', ident, 'entity_view_metadata.html')
+ return generic_entity_view("webcapture", ident, "entity_view_metadata.html")
+
-@app.route('/webcapture/rev/<uuid:revision_id>', methods=['GET'])
+@app.route("/webcapture/rev/<uuid:revision_id>", methods=["GET"])
def webcapture_revision_view(revision_id):
- return generic_entity_revision_view('webcapture', str(revision_id), 'webcapture_view.html')
+ return generic_entity_revision_view("webcapture", str(revision_id), "webcapture_view.html")
-@app.route('/webcapture/rev/<uuid:revision_id>/metadata', methods=['GET'])
+
+@app.route("/webcapture/rev/<uuid:revision_id>/metadata", methods=["GET"])
def webcapture_revision_view_metadata(revision_id):
- return generic_entity_revision_view('webcapture', str(revision_id), 'entity_view_metadata.html')
+ return generic_entity_revision_view(
+ "webcapture", str(revision_id), "entity_view_metadata.html"
+ )
+
-@app.route('/editgroup/<editgroup_id>/webcapture/<string(length=26):ident>', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/webcapture/<string(length=26):ident>", methods=["GET"])
def webcapture_editgroup_view(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'webcapture', ident, 'webcapture_view.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "webcapture", ident, "webcapture_view.html"
+ )
+
-@app.route('/editgroup/<editgroup_id>/webcapture/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route(
+ "/editgroup/<editgroup_id>/webcapture/<string(length=26):ident>/metadata", methods=["GET"]
+)
def webcapture_editgroup_view_metadata(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'webcapture', ident, 'entity_view_metadata.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "webcapture", ident, "entity_view_metadata.html"
+ )
-@app.route('/release/<string(length=26):ident>', methods=['GET'])
+@app.route("/release/<string(length=26):ident>", methods=["GET"])
def release_view(ident):
- return generic_entity_view('release', ident, 'release_view.html')
+ return generic_entity_view("release", ident, "release_view.html")
+
-@app.route('/release_<string(length=26):ident>', methods=['GET'])
+@app.route("/release_<string(length=26):ident>", methods=["GET"])
def release_underscore_view(ident):
- return redirect('/release/{}'.format(ident))
+ return redirect("/release/{}".format(ident))
+
-@app.route('/release/<string(length=26):ident>/contribs', methods=['GET'])
+@app.route("/release/<string(length=26):ident>/contribs", methods=["GET"])
def release_view_contribs(ident):
- return generic_entity_view('release', ident, 'release_view_contribs.html')
+ return generic_entity_view("release", ident, "release_view_contribs.html")
-@app.route('/release/<string(length=26):ident>/references', methods=['GET'])
+
+@app.route("/release/<string(length=26):ident>/references", methods=["GET"])
def release_view_references(ident):
- return generic_entity_view('release', ident, 'release_view_references.html')
+ return generic_entity_view("release", ident, "release_view_references.html")
+
-@app.route('/release/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/release/<string(length=26):ident>/metadata", methods=["GET"])
def release_view_metadata(ident):
- return generic_entity_view('release', ident, 'entity_view_metadata.html')
+ return generic_entity_view("release", ident, "entity_view_metadata.html")
+
-@app.route('/release/rev/<uuid:revision_id>', methods=['GET'])
+@app.route("/release/rev/<uuid:revision_id>", methods=["GET"])
def release_revision_view(revision_id):
- return generic_entity_revision_view('release', str(revision_id), 'release_view.html')
+ return generic_entity_revision_view("release", str(revision_id), "release_view.html")
-@app.route('/release/rev/<uuid:revision_id>/contribs', methods=['GET'])
+
+@app.route("/release/rev/<uuid:revision_id>/contribs", methods=["GET"])
def release_revision_view_contribs(revision_id):
- return generic_entity_revision_view('release', str(revision_id), 'release_view_contribs.html')
+ return generic_entity_revision_view(
+ "release", str(revision_id), "release_view_contribs.html"
+ )
+
-@app.route('/release/rev/<uuid:revision_id>/references', methods=['GET'])
+@app.route("/release/rev/<uuid:revision_id>/references", methods=["GET"])
def release_revision_view_references(revision_id):
- return generic_entity_revision_view('release', str(revision_id), 'release_view_references.html')
+ return generic_entity_revision_view(
+ "release", str(revision_id), "release_view_references.html"
+ )
+
-@app.route('/release/rev/<uuid:revision_id>/metadata', methods=['GET'])
+@app.route("/release/rev/<uuid:revision_id>/metadata", methods=["GET"])
def release_revision_view_metadata(revision_id):
- return generic_entity_revision_view('release', str(revision_id), 'entity_view_metadata.html')
+ return generic_entity_revision_view(
+ "release", str(revision_id), "entity_view_metadata.html"
+ )
+
-@app.route('/editgroup/<editgroup_id>/release/<string(length=26):ident>', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/release/<string(length=26):ident>", methods=["GET"])
def release_editgroup_view(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'release', ident, 'release_view.html')
+ return generic_editgroup_entity_view(editgroup_id, "release", ident, "release_view.html")
-@app.route('/editgroup/<editgroup_id>/release/<string(length=26):ident>/contribs', methods=['GET'])
+
+@app.route(
+ "/editgroup/<editgroup_id>/release/<string(length=26):ident>/contribs", methods=["GET"]
+)
def release_editgroup_view_contribs(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'release', ident, 'release_view_contribs.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "release", ident, "release_view_contribs.html"
+ )
-@app.route('/editgroup/<editgroup_id>/release/<string(length=26):ident>/references', methods=['GET'])
+
+@app.route(
+ "/editgroup/<editgroup_id>/release/<string(length=26):ident>/references", methods=["GET"]
+)
def release_editgroup_view_references(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'release', ident, 'release_view_references.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "release", ident, "release_view_references.html"
+ )
-@app.route('/editgroup/<editgroup_id>/release/<string(length=26):ident>/metadata', methods=['GET'])
+
+@app.route(
+ "/editgroup/<editgroup_id>/release/<string(length=26):ident>/metadata", methods=["GET"]
+)
def release_editgroup_view_metadata(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'release', ident, 'entity_view_metadata.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "release", ident, "entity_view_metadata.html"
+ )
-@app.route('/work/<string(length=26):ident>', methods=['GET'])
+@app.route("/work/<string(length=26):ident>", methods=["GET"])
def work_view(ident):
- return generic_entity_view('work', ident, 'work_view.html')
+ return generic_entity_view("work", ident, "work_view.html")
-@app.route('/work_<string(length=26):ident>', methods=['GET'])
+
+@app.route("/work_<string(length=26):ident>", methods=["GET"])
def work_underscore_view(ident):
- return redirect('/work/{}'.format(ident))
+ return redirect("/work/{}".format(ident))
+
-@app.route('/work/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/work/<string(length=26):ident>/metadata", methods=["GET"])
def work_view_metadata(ident):
- return generic_entity_view('work', ident, 'entity_view_metadata.html')
+ return generic_entity_view("work", ident, "entity_view_metadata.html")
+
-@app.route('/work/rev/<uuid:revision_id>', methods=['GET'])
+@app.route("/work/rev/<uuid:revision_id>", methods=["GET"])
def work_revision_view(revision_id):
- return generic_entity_revision_view('work', str(revision_id), 'work_view.html')
+ return generic_entity_revision_view("work", str(revision_id), "work_view.html")
-@app.route('/work/rev/<uuid:revision_id>/metadata', methods=['GET'])
+
+@app.route("/work/rev/<uuid:revision_id>/metadata", methods=["GET"])
def work_revision_view_metadata(revision_id):
- return generic_entity_revision_view('work', str(revision_id), 'entity_view_metadata.html')
+ return generic_entity_revision_view("work", str(revision_id), "entity_view_metadata.html")
+
-@app.route('/editgroup/<editgroup_id>/work/<string(length=26):ident>', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/work/<string(length=26):ident>", methods=["GET"])
def work_editgroup_view(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'work', ident, 'work_view.html')
+ return generic_editgroup_entity_view(editgroup_id, "work", ident, "work_view.html")
+
-@app.route('/editgroup/<editgroup_id>/work/<string(length=26):ident>/metadata', methods=['GET'])
+@app.route("/editgroup/<editgroup_id>/work/<string(length=26):ident>/metadata", methods=["GET"])
def work_editgroup_view_metadata(editgroup_id, ident):
- return generic_editgroup_entity_view(editgroup_id, 'work', ident, 'entity_view_metadata.html')
+ return generic_editgroup_entity_view(
+ editgroup_id, "work", ident, "entity_view_metadata.html"
+ )
### Views ###################################################################
-@app.route('/editgroup/<string(length=26):ident>', methods=['GET'])
+
+@app.route("/editgroup/<string(length=26):ident>", methods=["GET"])
def editgroup_view(ident):
try:
eg = api.get_editgroup(str(ident))
@@ -537,28 +671,28 @@ def editgroup_view(ident):
edit=False,
annotate=False,
)
- if session.get('editor'):
- user = load_user(session['editor']['editor_id'])
- auth_to['annotate'] = True
+ 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
+ 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)
+ auth_to["accept"] = True
+ return render_template("editgroup_view.html", editgroup=eg, auth_to=auth_to)
+
-@app.route('/editgroup/<string(length=26):ident>/annotation', methods=['POST'])
+@app.route("/editgroup/<string(length=26):ident>/annotation", methods=["POST"])
@login_required
def editgroup_create_annotation(ident):
if not app.testing:
app.csrf.protect()
- comment_markdown = request.form.get('comment_markdown')
+ comment_markdown = request.form.get("comment_markdown")
if not comment_markdown:
app.log.info("empty comment field")
abort(400)
# on behalf of user...
- user_api = auth_api(session['api_token'])
+ user_api = auth_api(session["api_token"])
try:
eg = user_api.get_editgroup(str(ident))
if eg.changelog_index:
@@ -571,15 +705,16 @@ def editgroup_create_annotation(ident):
except ApiException as ae:
app.log.info(ae)
raise ae
- return redirect('/editgroup/{}'.format(ident))
+ return redirect("/editgroup/{}".format(ident))
-@app.route('/editgroup/<string(length=26):ident>/accept', methods=['POST'])
+
+@app.route("/editgroup/<string(length=26):ident>/accept", methods=["POST"])
@login_required
def editgroup_accept(ident):
if not app.testing:
app.csrf.protect()
# on behalf of user...
- user_api = auth_api(session['api_token'])
+ user_api = auth_api(session["api_token"])
try:
eg = user_api.get_editgroup(str(ident))
if eg.changelog_index:
@@ -588,15 +723,16 @@ def editgroup_accept(ident):
except ApiException as ae:
app.log.info(ae)
abort(ae.status)
- return redirect('/editgroup/{}'.format(ident))
+ return redirect("/editgroup/{}".format(ident))
+
-@app.route('/editgroup/<string(length=26):ident>/unsubmit', methods=['POST'])
+@app.route("/editgroup/<string(length=26):ident>/unsubmit", methods=["POST"])
@login_required
def editgroup_unsubmit(ident):
if not app.testing:
app.csrf.protect()
# on behalf of user...
- user_api = auth_api(session['api_token'])
+ user_api = auth_api(session["api_token"])
try:
eg = user_api.get_editgroup(str(ident))
if eg.changelog_index:
@@ -605,15 +741,16 @@ def editgroup_unsubmit(ident):
except ApiException as ae:
app.log.info(ae)
abort(ae.status)
- return redirect('/editgroup/{}'.format(ident))
+ return redirect("/editgroup/{}".format(ident))
+
-@app.route('/editgroup/<string(length=26):ident>/submit', methods=['POST'])
+@app.route("/editgroup/<string(length=26):ident>/submit", methods=["POST"])
@login_required
def editgroup_submit(ident):
if not app.testing:
app.csrf.protect()
# on behalf of user...
- user_api = auth_api(session['api_token'])
+ user_api = auth_api(session["api_token"])
try:
eg = user_api.get_editgroup(str(ident))
if eg.changelog_index:
@@ -622,17 +759,19 @@ def editgroup_submit(ident):
except ApiException as ae:
app.log.info(ae)
abort(ae.status)
- return redirect('/editgroup/{}'.format(ident))
+ return redirect("/editgroup/{}".format(ident))
-@app.route('/editor/<string(length=26):ident>', methods=['GET'])
+
+@app.route("/editor/<string(length=26):ident>", methods=["GET"])
def editor_view(ident):
try:
entity = api.get_editor(ident)
except ApiException as ae:
abort(ae.status)
- return render_template('editor_view.html', editor=entity)
+ return render_template("editor_view.html", editor=entity)
+
-@app.route('/editor/<string(length=26):ident>/editgroups', methods=['GET'])
+@app.route("/editor/<string(length=26):ident>/editgroups", methods=["GET"])
def editor_editgroups(ident):
try:
editor = api.get_editor(ident)
@@ -642,57 +781,62 @@ def editor_editgroups(ident):
eg.editor = editor
except ApiException as ae:
abort(ae.status)
- return render_template('editor_editgroups.html', editor=editor,
- editgroups=editgroups)
+ return render_template("editor_editgroups.html", editor=editor, editgroups=editgroups)
-@app.route('/editor/<string(length=26):ident>/annotations', methods=['GET'])
+
+@app.route("/editor/<string(length=26):ident>/annotations", methods=["GET"])
def editor_annotations(ident):
try:
editor = api.get_editor(ident)
annotations = api.get_editor_annotations(ident, limit=50)
except ApiException as ae:
abort(ae.status)
- return render_template('editor_annotations.html', editor=editor,
- annotations=annotations)
+ return render_template("editor_annotations.html", editor=editor, annotations=annotations)
+
-@app.route('/u/<string:username>', methods=['GET', 'HEAD'])
+@app.route("/u/<string:username>", methods=["GET", "HEAD"])
def editor_username_redirect(username):
try:
editor = api.lookup_editor(username=username)
except ApiException as ae:
abort(ae.status)
- return redirect(f'/editor/{editor.editor_id}')
+ return redirect(f"/editor/{editor.editor_id}")
-@app.route('/changelog', methods=['GET'])
+
+@app.route("/changelog", methods=["GET"])
def changelog_view():
try:
- #limit = int(request.args.get('limit', 10))
- entries = api.get_changelog() # TODO: expand="editors"
+ # limit = int(request.args.get('limit', 10))
+ entries = api.get_changelog() # TODO: expand="editors"
except ApiException as ae:
abort(ae.status)
- return render_template('changelog.html', entries=entries)
+ return render_template("changelog.html", entries=entries)
+
-@app.route('/changelog/<int:index>', methods=['GET'])
+@app.route("/changelog/<int:index>", methods=["GET"])
def changelog_entry_view(index):
try:
entry = api.get_changelog_entry(int(index))
entry.editgroup.editor = api.get_editor(entry.editgroup.editor_id)
- entry.editgroup.annotations = \
- api.get_editgroup_annotations(entry.editgroup_id, expand="editors")
+ entry.editgroup.annotations = api.get_editgroup_annotations(
+ entry.editgroup_id, expand="editors"
+ )
except ApiException as ae:
abort(ae.status)
- return render_template('changelog_view.html', entry=entry, editgroup=entry.editgroup)
+ return render_template("changelog_view.html", entry=entry, editgroup=entry.editgroup)
-@app.route('/reviewable', methods=['GET'])
+
+@app.route("/reviewable", methods=["GET"])
def reviewable_view():
try:
- #limit = int(request.args.get('limit', 10))
+ # limit = int(request.args.get('limit', 10))
entries = api.get_editgroups_reviewable(expand="editors")
except ApiException as ae:
abort(ae.status)
- return render_template('editgroup_reviewable.html', entries=entries)
+ return render_template("editgroup_reviewable.html", entries=entries)
+
-@app.route('/release/<string(length=26):ident>/save', methods=['GET', 'POST'])
+@app.route("/release/<string(length=26):ident>/save", methods=["GET", "POST"])
def release_save(ident):
form = SavePaperNowForm()
@@ -704,7 +848,12 @@ def release_save(ident):
abort(ae.status)
if not Config.KAFKA_PIXY_ENDPOINT:
- return render_template('release_save.html', entity=release, form=form, spn_status='not-configured'), 501
+ return (
+ render_template(
+ "release_save.html", entity=release, form=form, spn_status="not-configured"
+ ),
+ 501,
+ )
if form.is_submitted():
if form.validate_on_submit():
@@ -716,10 +865,20 @@ def release_save(ident):
json.dumps(msg, sort_keys=True),
)
except Exception:
- return render_template('release_save.html', entity=release, form=form, spn_status='kafka-error'), 500
- return render_template('release_save.html', entity=release, form=form, spn_status='success'), 200
+ return (
+ render_template(
+ "release_save.html", entity=release, form=form, spn_status="kafka-error"
+ ),
+ 500,
+ )
+ return (
+ render_template(
+ "release_save.html", entity=release, form=form, spn_status="success"
+ ),
+ 200,
+ )
elif form.errors:
- return render_template('release_save.html', entity=release, form=form), 400
+ return render_template("release_save.html", entity=release, form=form), 400
# form was not submitted; populate defaults
if release.release_stage:
@@ -729,50 +888,57 @@ def release_save(ident):
elif release.ext_ids.arxiv:
form.base_url.data = "https://arxiv.org/pdf/{}.pdf".format(release.ext_ids.arxiv)
elif release.ext_ids.pmcid:
- form.base_url.data = "https://europepmc.org/backend/ptpmcrender.fcgi?accid={}&blobtype=pdf".format(release.ext_ids.pmcid)
+ form.base_url.data = (
+ "https://europepmc.org/backend/ptpmcrender.fcgi?accid={}&blobtype=pdf".format(
+ release.ext_ids.pmcid
+ )
+ )
elif release.ext_ids.hdl:
form.base_url.data = "https://hdl.handle.net/{}".format(release.ext_ids.hdl)
- return render_template('release_save.html', entity=release, form=form), 200
+ return render_template("release_save.html", entity=release, form=form), 200
+
### Search ##################################################################
-@app.route('/search', methods=['GET', 'POST'])
+
+@app.route("/search", methods=["GET", "POST"])
def generic_search():
- if 'q' not in request.args.keys():
- return redirect('/release/search')
- query = request.args.get('q').strip()
+ if "q" not in request.args.keys():
+ return redirect("/release/search")
+ query = request.args.get("q").strip()
if len(query.split()) != 1:
# multi-term? must be a real search
- return redirect(url_for('release_search', q=query, generic=1))
+ return redirect(url_for("release_search", q=query, generic=1))
if clean_doi(query):
- return redirect(url_for('release_lookup', doi=clean_doi(query)))
+ return redirect(url_for("release_lookup", doi=clean_doi(query)))
if clean_pmcid(query):
- return redirect(url_for('release_lookup', pmcid=clean_pmcid(query)))
+ return redirect(url_for("release_lookup", pmcid=clean_pmcid(query)))
if clean_sha1(query):
- return redirect(url_for('file_lookup', sha1=clean_sha1(query)))
+ return redirect(url_for("file_lookup", sha1=clean_sha1(query)))
if clean_sha256(query):
- return redirect(url_for('file_lookup', sha256=clean_sha256(query)))
+ return redirect(url_for("file_lookup", sha256=clean_sha256(query)))
if clean_issn(query):
- return redirect(url_for('container_lookup', issnl=clean_issn(query)))
+ return redirect(url_for("container_lookup", issnl=clean_issn(query)))
if clean_isbn13(query):
- return redirect(url_for('release_lookup', isbn13=clean_isbn13(query)))
+ return redirect(url_for("release_lookup", isbn13=clean_isbn13(query)))
if clean_arxiv_id(query):
- return redirect(url_for('release_lookup', arxiv=clean_arxiv_id(query)))
+ return redirect(url_for("release_lookup", arxiv=clean_arxiv_id(query)))
if clean_orcid(query):
- return redirect(url_for('creator_lookup', orcid=clean_orcid(query)))
+ return redirect(url_for("creator_lookup", orcid=clean_orcid(query)))
+
+ return redirect(url_for("release_search", q=query, generic=1))
- return redirect(url_for('release_search', q=query, generic=1))
-@app.route('/release/search', methods=['GET', 'POST'])
+@app.route("/release/search", methods=["GET", "POST"])
def release_search():
- if 'q' not in request.args.keys():
- return render_template('release_search.html', query=ReleaseQuery(), found=None)
+ if "q" not in request.args.keys():
+ return render_template("release_search.html", query=ReleaseQuery(), found=None)
container_found = None
- if request.args.get('generic'):
+ if request.args.get("generic"):
container_query = GenericQuery.from_args(request.args)
container_query.limit = 1
try:
@@ -784,28 +950,38 @@ def release_search():
try:
found = do_release_search(query)
except FatcatSearchError as fse:
- return render_template('release_search.html', query=query, es_error=fse), fse.status_code
- return render_template('release_search.html', query=query, found=found, container_found=container_found)
+ return (
+ render_template("release_search.html", query=query, es_error=fse),
+ fse.status_code,
+ )
+ return render_template(
+ "release_search.html", query=query, found=found, container_found=container_found
+ )
+
-@app.route('/container/search', methods=['GET', 'POST'])
+@app.route("/container/search", methods=["GET", "POST"])
def container_search():
- if 'q' not in request.args.keys():
- return render_template('container_search.html', query=GenericQuery(), found=None)
+ if "q" not in request.args.keys():
+ return render_template("container_search.html", query=GenericQuery(), found=None)
query = GenericQuery.from_args(request.args)
try:
found = do_container_search(query)
except FatcatSearchError as fse:
- return render_template('container_search.html', query=query, es_error=fse), fse.status_code
- return render_template('container_search.html', query=query, found=found)
+ return (
+ render_template("container_search.html", query=query, es_error=fse),
+ fse.status_code,
+ )
+ return render_template("container_search.html", query=query, found=found)
+
-@app.route('/coverage/search', methods=['GET', 'POST'])
+@app.route("/coverage/search", methods=["GET", "POST"])
def coverage_search():
- if 'q' not in request.args.keys():
+ if "q" not in request.args.keys():
return render_template(
- 'coverage_search.html',
+ "coverage_search.html",
query=ReleaseQuery(),
coverage_stats=None,
coverage_type_preservation=None,
@@ -817,19 +993,22 @@ def coverage_search():
try:
coverage_stats = get_elastic_search_coverage(query)
except FatcatSearchError as fse:
- return render_template(
- 'coverage_search.html',
- query=query,
- coverage_stats=None,
- coverage_type_preservation=None,
- year_histogram_svg=None,
- date_histogram_svg=None,
- es_error=fse,
- ), fse.status_code
+ return (
+ render_template(
+ "coverage_search.html",
+ query=query,
+ coverage_stats=None,
+ coverage_type_preservation=None,
+ year_histogram_svg=None,
+ date_histogram_svg=None,
+ es_error=fse,
+ ),
+ fse.status_code,
+ )
year_histogram_svg = None
date_histogram_svg = None
coverage_type_preservation = None
- if coverage_stats['total'] > 1:
+ if coverage_stats["total"] > 1:
coverage_type_preservation = get_elastic_preservation_by_type(query)
if query.recent:
date_histogram = get_elastic_preservation_by_date(query)
@@ -844,7 +1023,7 @@ def coverage_search():
merge_shadows=Config.FATCAT_MERGE_SHADOW_PRESERVATION,
).render_data_uri()
return render_template(
- 'coverage_search.html',
+ "coverage_search.html",
query=query,
coverage_stats=coverage_stats,
coverage_type_preservation=coverage_type_preservation,
@@ -852,16 +1031,20 @@ def coverage_search():
date_histogram_svg=date_histogram_svg,
)
+
def get_changelog_stats():
stats = {}
latest_changelog = api.get_changelog(limit=1)[0]
- stats['changelog'] = {"latest": {
- "index": latest_changelog.index,
- "timestamp": latest_changelog.timestamp.isoformat(),
- }}
+ stats["changelog"] = {
+ "latest": {
+ "index": latest_changelog.index,
+ "timestamp": latest_changelog.timestamp.isoformat(),
+ }
+ }
return stats
-@app.route('/stats', methods=['GET'])
+
+@app.route("/stats", methods=["GET"])
def stats_page():
try:
stats = get_elastic_entity_stats()
@@ -869,12 +1052,14 @@ def stats_page():
except Exception as ae:
app.log.error(ae)
abort(503)
- return render_template('stats.html', stats=stats)
+ return render_template("stats.html", stats=stats)
+
### Pseudo-APIs #############################################################
-@app.route('/stats.json', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route("/stats.json", methods=["GET", "OPTIONS"])
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def stats_json():
try:
stats = get_elastic_entity_stats()
@@ -884,10 +1069,11 @@ def stats_json():
abort(503)
return jsonify(stats)
-@app.route('/container/issnl/<issnl>/stats.json', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route("/container/issnl/<issnl>/stats.json", methods=["GET", "OPTIONS"])
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_issnl_stats(issnl):
- if not (len(issnl) == 9 and issnl[4] == '-'):
+ if not (len(issnl) == 9 and issnl[4] == "-"):
abort(400, "Not a valid ISSN-L: {}".format(issnl))
try:
container = api.lookup_container(issnl=issnl)
@@ -900,8 +1086,9 @@ def container_issnl_stats(issnl):
abort(503)
return jsonify(stats)
-@app.route('/container/<string(length=26):ident>/stats.json', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route("/container/<string(length=26):ident>/stats.json", methods=["GET", "OPTIONS"])
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_ident_stats(ident):
try:
container = api.get_container(ident)
@@ -914,8 +1101,11 @@ def container_ident_stats(ident):
abort(503)
return jsonify(stats)
-@app.route('/container/<string(length=26):ident>/ia_coverage_years.json', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route(
+ "/container/<string(length=26):ident>/ia_coverage_years.json", methods=["GET", "OPTIONS"]
+)
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_ident_ia_coverage_years_json(ident):
try:
container = api.get_container(ident)
@@ -927,10 +1117,13 @@ def container_ident_ia_coverage_years_json(ident):
app.log.error(ae)
abort(503)
histogram = [dict(year=h[0], in_ia=h[1], count=h[2]) for h in histogram]
- return jsonify({'container_id': ident, "histogram": histogram})
+ return jsonify({"container_id": ident, "histogram": histogram})
-@app.route('/container/<string(length=26):ident>/ia_coverage_years.svg', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route(
+ "/container/<string(length=26):ident>/ia_coverage_years.svg", methods=["GET", "OPTIONS"]
+)
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_ident_ia_coverage_years_svg(ident):
try:
container = api.get_container(ident)
@@ -943,8 +1136,11 @@ def container_ident_ia_coverage_years_svg(ident):
abort(503)
return ia_coverage_histogram(histogram).render_response()
-@app.route('/container/<string(length=26):ident>/preservation_by_year.json', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route(
+ "/container/<string(length=26):ident>/preservation_by_year.json", methods=["GET", "OPTIONS"]
+)
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_ident_preservation_by_year_json(ident):
try:
container = api.get_container(ident)
@@ -956,10 +1152,13 @@ def container_ident_preservation_by_year_json(ident):
except Exception as ae:
app.log.error(ae)
abort(503)
- return jsonify({'container_id': ident, "histogram": histogram})
+ return jsonify({"container_id": ident, "histogram": histogram})
+
-@app.route('/container/<string(length=26):ident>/preservation_by_year.svg', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+@app.route(
+ "/container/<string(length=26):ident>/preservation_by_year.svg", methods=["GET", "OPTIONS"]
+)
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_ident_preservation_by_year_svg(ident):
try:
container = api.get_container(ident)
@@ -976,8 +1175,12 @@ def container_ident_preservation_by_year_svg(ident):
merge_shadows=Config.FATCAT_MERGE_SHADOW_PRESERVATION,
).render_response()
-@app.route('/container/<string(length=26):ident>/preservation_by_volume.json', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route(
+ "/container/<string(length=26):ident>/preservation_by_volume.json",
+ methods=["GET", "OPTIONS"],
+)
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_ident_preservation_by_volume_json(ident):
try:
container = api.get_container(ident)
@@ -988,10 +1191,14 @@ def container_ident_preservation_by_volume_json(ident):
except Exception as ae:
app.log.error(ae)
abort(503)
- return jsonify({'container_id': ident, "histogram": histogram})
+ return jsonify({"container_id": ident, "histogram": histogram})
+
-@app.route('/container/<string(length=26):ident>/preservation_by_volume.svg', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+@app.route(
+ "/container/<string(length=26):ident>/preservation_by_volume.svg",
+ methods=["GET", "OPTIONS"],
+)
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def container_ident_preservation_by_volume_svg(ident):
try:
container = api.get_container(ident)
@@ -1007,21 +1214,23 @@ def container_ident_preservation_by_volume_svg(ident):
merge_shadows=Config.FATCAT_MERGE_SHADOW_PRESERVATION,
).render_response()
-@app.route('/release/<string(length=26):ident>.bib', methods=['GET'])
+
+@app.route("/release/<string(length=26):ident>.bib", methods=["GET"])
def release_bibtex(ident):
try:
entity = api.get_release(ident)
except ApiException as ae:
raise ae
csl = release_to_csl(entity)
- bibtex = citeproc_csl(csl, 'bibtex')
+ bibtex = citeproc_csl(csl, "bibtex")
return Response(bibtex, mimetype="text/plain")
-@app.route('/release/<string(length=26):ident>/citeproc', methods=['GET'])
+
+@app.route("/release/<string(length=26):ident>/citeproc", methods=["GET"])
def release_citeproc(ident):
- style = request.args.get('style', 'harvard1')
- is_html = request.args.get('html', False)
- if is_html and is_html.lower() in ('yes', '1', 'true', 'y', 't'):
+ style = request.args.get("style", "harvard1")
+ is_html = request.args.get("html", False)
+ if is_html and is_html.lower() in ("yes", "1", "true", "y", "t"):
is_html = True
else:
is_html = False
@@ -1042,67 +1251,75 @@ def release_citeproc(ident):
else:
return Response(cite, mimetype="text/plain")
-@app.route('/health.json', methods=['GET', 'OPTIONS'])
-@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
+
+@app.route("/health.json", methods=["GET", "OPTIONS"])
+@crossdomain(origin="*", headers=["access-control-allow-origin", "Content-Type"])
def health_json():
- return jsonify({'ok': True})
+ return jsonify({"ok": True})
### Auth ####################################################################
-@app.route('/auth/login')
+
+@app.route("/auth/login")
def login():
# show the user a list of login options
if not priv_api:
- app.log.warn("This web interface not configured with credentials to actually allow login (other than via token)")
- return render_template('auth_login.html')
+ app.log.warn(
+ "This web interface not configured with credentials to actually allow login (other than via token)"
+ )
+ return render_template("auth_login.html")
-@app.route('/auth/ia/login', methods=['GET', 'POST'])
+
+@app.route("/auth/ia/login", methods=["GET", "POST"])
def ia_xauth_login():
- if 'email' in request.form:
+ if "email" in request.form:
# if a login attempt...
- return handle_ia_xauth(request.form.get('email'), request.form.get('password'))
+ return handle_ia_xauth(request.form.get("email"), request.form.get("password"))
# else show form
- return render_template('auth_ia_login.html')
+ return render_template("auth_ia_login.html")
+
-@app.route('/auth/token_login', methods=['GET', 'POST'])
+@app.route("/auth/token_login", methods=["GET", "POST"])
def token_login():
# show the user a list of login options
- if 'token' in request.args:
- return handle_token_login(request.args.get('token'))
- if 'token' in request.form:
- return handle_token_login(request.form.get('token'))
- return render_template('auth_token_login.html')
+ if "token" in request.args:
+ return handle_token_login(request.args.get("token"))
+ if "token" in request.form:
+ return handle_token_login(request.form.get("token"))
+ return render_template("auth_token_login.html")
-@app.route('/auth/change_username', methods=['POST'])
+
+@app.route("/auth/change_username", methods=["POST"])
@login_required
def change_username():
if not app.testing:
app.csrf.protect()
# show the user a list of login options
- if 'username' not in request.form:
+ if "username" not in request.form:
abort(400)
# on behalf of user...
- user_api = auth_api(session['api_token'])
+ user_api = auth_api(session["api_token"])
try:
- editor = user_api.get_editor(session['editor']['editor_id'])
- editor.username = request.form['username']
+ editor = user_api.get_editor(session["editor"]["editor_id"])
+ editor.username = request.form["username"]
editor = user_api.update_editor(editor.editor_id, editor)
except ApiException as ae:
app.log.info(ae)
raise ae
# update our session
- session['editor'] = editor.to_dict()
+ session["editor"] = editor.to_dict()
load_user(editor.editor_id)
- return redirect('/auth/account')
+ return redirect("/auth/account")
+
-@app.route('/auth/create_token', methods=['POST'])
+@app.route("/auth/create_token", methods=["POST"])
@login_required
def create_auth_token():
if not app.testing:
app.csrf.protect()
- duration_seconds = request.form.get('duration_seconds', None)
+ duration_seconds = request.form.get("duration_seconds", None)
if duration_seconds:
try:
duration_seconds = int(duration_seconds)
@@ -1114,88 +1331,99 @@ def create_auth_token():
# cookie, so if api_token is valid editor_id is assumed to match. If that
# wasn't true, users could manipulate session cookies and create tokens for
# any user
- user_api = auth_api(session['api_token'])
+ user_api = auth_api(session["api_token"])
resp = user_api.auth_check()
- assert(resp.success)
+ assert resp.success
# generate token using *superuser* privs
- editor_id = session['editor']['editor_id']
+ editor_id = session["editor"]["editor_id"]
try:
- resp = priv_api.create_auth_token(editor_id,
- duration_seconds=duration_seconds)
+ resp = priv_api.create_auth_token(editor_id, duration_seconds=duration_seconds)
except ApiException as ae:
app.log.info(ae)
raise ae
- return render_template('auth_token.html', auth_token=resp.token)
+ return render_template("auth_token.html", auth_token=resp.token)
-@app.route('/auth/logout')
+
+@app.route("/auth/logout")
def logout():
handle_logout()
- return render_template('auth_logout.html')
+ return render_template("auth_logout.html")
+
-@app.route('/auth/account')
+@app.route("/auth/account")
@login_required
def auth_account():
# auth check on account page
- user_api = auth_api(session['api_token'])
+ user_api = auth_api(session["api_token"])
resp = user_api.auth_check()
- assert(resp.success)
- editor = user_api.get_editor(session['editor']['editor_id'])
- session['editor'] = editor.to_dict()
+ assert resp.success
+ editor = user_api.get_editor(session["editor"]["editor_id"])
+ session["editor"] = editor.to_dict()
load_user(editor.editor_id)
- return render_template('auth_account.html')
+ return render_template("auth_account.html")
+
-@app.route('/auth/wikipedia/auth')
+@app.route("/auth/wikipedia/auth")
def wp_oauth_rewrite():
"""
This is a dirty hack to rewrite '/auth/wikipedia/auth' to '/auth/wikipedia/oauth-callback'
"""
return redirect(
- (b"/auth/wikipedia/oauth-callback?" + request.query_string).decode('utf-8'),
+ (b"/auth/wikipedia/oauth-callback?" + request.query_string).decode("utf-8"),
307,
)
-@app.route('/auth/wikipedia/finish-login')
+
+@app.route("/auth/wikipedia/finish-login")
def wp_oauth_finish_login():
wp_username = mwoauth.get_current_user(cached=True)
- assert(wp_username)
+ assert wp_username
return handle_wmoauth(wp_username)
### Static Routes ###########################################################
+
@app.errorhandler(404)
def page_not_found(e):
- return render_template('404.html'), 404
+ return render_template("404.html"), 404
+
@app.errorhandler(401)
@app.errorhandler(403)
def page_not_authorized(e):
- return render_template('403.html'), 403
+ return render_template("403.html"), 403
+
@app.errorhandler(405)
def page_method_not_allowed(e):
- return render_template('405.html'), 405
+ return render_template("405.html"), 405
+
@app.errorhandler(400)
def page_bad_request(e):
- return render_template('400.html', err=e), 400
+ return render_template("400.html", err=e), 400
+
@app.errorhandler(409)
def page_edit_conflict(e):
- return render_template('409.html'), 409
+ return render_template("409.html"), 409
+
@app.errorhandler(500)
def page_server_error(e):
app.log.error(e)
- return render_template('500.html'), 500
+ return render_template("500.html"), 500
+
@app.errorhandler(502)
@app.errorhandler(503)
@app.errorhandler(504)
def page_server_down(e):
app.log.error(e)
- return render_template('503.html'), 503
+ return render_template("503.html"), 503
+
@app.errorhandler(ApiException)
def page_fatcat_api_error(ae):
@@ -1214,47 +1442,54 @@ def page_fatcat_api_error(ae):
return page_edit_conflict(ae)
try:
json_body = json.loads(ae.body)
- ae.error_name = json_body.get('error')
- ae.message = json_body.get('message')
+ ae.error_name = json_body.get("error")
+ ae.message = json_body.get("message")
except ValueError:
pass
- return render_template('api_error.html', api_error=ae), ae.status
+ return render_template("api_error.html", api_error=ae), ae.status
+
@app.errorhandler(ApiValueError)
def page_fatcat_api_value_error(ae):
ae.status = 400
ae.error_name = "ValueError"
ae.message = str(ae)
- return render_template('api_error.html', api_error=ae), 400
+ return render_template("api_error.html", api_error=ae), 400
+
@app.errorhandler(CSRFError)
def page_csrf_error(e):
- return render_template('csrf_error.html', reason=e.description), 400
+ return render_template("csrf_error.html", reason=e.description), 400
+
-@app.route('/', methods=['GET'])
+@app.route("/", methods=["GET"])
def page_home():
- return render_template('home.html')
+ return render_template("home.html")
-@app.route('/about', methods=['GET'])
+
+@app.route("/about", methods=["GET"])
def page_about():
- return render_template('about.html')
+ return render_template("about.html")
+
-@app.route('/rfc', methods=['GET'])
+@app.route("/rfc", methods=["GET"])
def page_rfc():
- return render_template('rfc.html')
+ return render_template("rfc.html")
+
-@app.route('/robots.txt', methods=['GET'])
+@app.route("/robots.txt", methods=["GET"])
def page_robots_txt():
- if app.config['FATCAT_DOMAIN'] == "fatcat.wiki":
+ if app.config["FATCAT_DOMAIN"] == "fatcat.wiki":
robots_path = "robots.txt"
else:
robots_path = "robots.deny_all.txt"
- return send_from_directory(os.path.join(app.root_path, 'static'),
- robots_path,
- mimetype='text/plain')
+ return send_from_directory(
+ os.path.join(app.root_path, "static"), robots_path, mimetype="text/plain"
+ )
+
-@app.route('/sitemap.xml', methods=['GET'])
+@app.route("/sitemap.xml", methods=["GET"])
def page_sitemap_xml():
- return send_from_directory(os.path.join(app.root_path, 'static'),
- "sitemap.xml",
- mimetype='text/xml')
+ return send_from_directory(
+ os.path.join(app.root_path, "static"), "sitemap.xml", mimetype="text/xml"
+ )