aboutsummaryrefslogtreecommitdiffstats
path: root/python/fatcat_web/ref_routes.py
blob: 2d8ed41333513439498368727cec44831321daf2 (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
"""
Flask endpoints for reference (citation) endpoints. Eg, listing references
"inbound" and "outbound" from a specific release or work.
"""

import json

from flask import render_template, request, Response, jsonify
from fatcat_openapi_client import *
from fuzzycat.grobid_unstructured import grobid_api_process_citation, transform_grobid_ref_xml, grobid_ref_to_release
from fuzzycat.simple import close_fuzzy_biblio_matches, close_fuzzy_release_matches

from fatcat_tools.references import enrich_inbound_refs, enrich_outbound_refs, get_inbound_refs, get_outbound_refs, RefHits
from fatcat_tools.transforms.access import release_access_options
from fatcat_tools.transforms.entities import entity_to_dict
from fatcat_web import app, api
from fatcat_web.cors import crossdomain
from fatcat_web.forms import *
from fatcat_web.entity_helpers import *

def _refs_web(direction, release_ident=None, work_ident=None, openlibrary_id=None, wikipedia_article=None) -> RefHits:
    offset = request.args.get('offset', '0')
    offset = max(0, int(offset)) if offset.isnumeric() else 0
    limit = request.args.get('limit', '30')
    limit = min(max(0, int(limit)), 100) if limit.isnumeric() else 30
    if direction == "in":
        hits = get_inbound_refs(
            release_ident=release_ident,
            work_ident=work_ident,
            openlibrary_work=openlibrary_id,
            es_client=app.es_client,
            offset=offset,
            limit=limit,
        )
        hits.result_refs = enrich_inbound_refs(
            hits.result_refs,
            fatcat_api_client=api,
            expand="container,files,webcaptures",
        )
    elif direction == "out":
        hits = get_outbound_refs(
            release_ident=release_ident,
            wikipedia_article=wikipedia_article,
            work_ident=work_ident,
            es_client=app.es_client,
            offset=offset,
            limit=limit,
        )
        hits.result_refs = enrich_outbound_refs(
            hits.result_refs,
            fatcat_api_client=api,
            expand="container,files,webcaptures",
        )
    else:
        raise ValueError()
    return hits


@app.route('/release/<string(length=26):ident>/refs-in', methods=['GET'])
def release_view_refs_inbound(ident):
    if request.accept_mimetypes.best == "application/json":
        return release_view_refs_inbound_json(ident)

    release = generic_get_entity("release", ident)
    hits = _refs_web("in", release_ident=ident)
    return render_template('release_view_fuzzy_refs.html', direction="in", entity=release, hits=hits), 200


@app.route('/release/<string(length=26):ident>/refs-out', methods=['GET'])
def release_view_refs_outbound(ident):
    if request.accept_mimetypes.best == "application/json":
        return release_view_refs_outbound_json(ident)

    release = generic_get_entity("release", ident)
    hits = _refs_web("out", release_ident=ident)
    return render_template('release_view_fuzzy_refs.html', direction="out", entity=release, hits=hits), 200

@app.route('/openlibrary/OL<int:id_num>W/refs-in', methods=['GET'])
def openlibrary_view_refs_inbound(id_num):
    if request.accept_mimetypes.best == "application/json":
        return openlibrary_view_refs_inbound_json(id_num)

    openlibrary_id = f"OL{id_num}W"
    hits = _refs_web("in", openlibrary_id=openlibrary_id)
    return render_template('openlibrary_view_fuzzy_refs.html', openlibrary_id=openlibrary_id, direction="in", hits=hits), 200

@app.route('/wikipedia/<string(length=2):wiki_lang>:<string:wiki_article>/refs-out', methods=['GET'])
def wikipedia_view_refs_outbound(wiki_lang: str, wiki_article: str):
    if request.accept_mimetypes.best == "application/json":
        return wikipedia_view_refs_outbound_json(wiki_lang, wiki_article)

    wiki_url = f"https://{wiki_lang}.wikipedia.org/wiki/{wiki_article}"
    wiki_article = wiki_article.replace('_', ' ')
    wikipedia_article = wiki_lang + ":" + wiki_article
    hits = _refs_web("out", wikipedia_article=wikipedia_article)
    return render_template('wikipedia_view_fuzzy_refs.html', wiki_article=wiki_article, wiki_lang=wiki_lang, wiki_url=wiki_url, direction="out", hits=hits), 200

@app.route('/reference/match', methods=['GET', 'POST'])
def reference_match():

    grobid_status = None
    grobid_dict = None

    form = ReferenceMatchForm()
    if not form.is_submitted() and request.args.get('submit_type'):
        form = ReferenceMatchForm(request.args)

    if form.is_submitted() or request.args.get('title'):
        if form.validate():
            if form.submit_type.data == 'parse':
                resp_xml = grobid_api_process_citation(form.raw_citation.data)
                if not resp_xml:
                    grobid_status = "failed"
                    return render_template('reference_match.html', form=form, grobid_status=grobid_status), 400
                grobid_dict = transform_grobid_ref_xml(resp_xml)
                if not grobid_dict:
                    grobid_status = "empty"
                    return render_template('reference_match.html', form=form, grobid_status=grobid_status), 200
                #print(grobid_dict)
                release_stub = grobid_ref_to_release(grobid_dict)
                # remove empty values from GROBID parsed dict
                grobid_dict = {k: v for k, v in grobid_dict.items() if v is not None}
                form = ReferenceMatchForm.from_grobid_parse(grobid_dict, form.raw_citation.data)
                grobid_status = "success"
                matches = close_fuzzy_release_matches(es_client=app.es_client, release=release_stub, match_limit=10) or []
            elif form.submit_type.data == 'match':
                matches = close_fuzzy_biblio_matches(es_client=app.es_client, biblio=form.data, match_limit=10) or []
            else:
                raise NotImplementedError()

            for m in matches:
                # expand releases more completely
                m.release = api.get_release(m.release.ident, expand="container,files,filesets,webcaptures", hide="abstract,refs")
                # hack in access options
                m.access_options = release_access_options(m.release)

            return render_template('reference_match.html', form=form, grobid_dict=grobid_dict, grobid_status=grobid_status, matches=matches), 200

        elif form.errors:
            return render_template('reference_match.html', form=form), 400

    return render_template('reference_match.html', form=form), 200


### Pseudo-APIs #############################################################

@app.route('/release/<string(length=26):ident>/refs-out.json', methods=['GET', 'OPTIONS'])
@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
def release_view_refs_outbound_json(ident):
    hits = _refs_web("out", release_ident=ident)
    return Response(hits.json(exclude_unset=True), mimetype="application/json")


@app.route('/release/<string(length=26):ident>/refs-in.json', methods=['GET', 'OPTIONS'])
@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
def release_view_refs_inbound_json(ident):
    hits = _refs_web("in", release_ident=ident)
    return Response(hits.json(exclude_unset=True), mimetype="application/json")

@app.route('/openlibrary/OL<int:id_num>W/refs-in.json', methods=['GET', 'OPTIONS'])
@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
def openlibrary_view_refs_inbound_json(id_num):
    openlibrary_id = f"OL{id_num}W"
    hits = _refs_web("in", openlibrary_id=openlibrary_id)
    return Response(hits.json(exclude_unset=True), mimetype="application/json")

@app.route('/wikipedia/<string(length=2):wiki_lang>:<string:wiki_article>/refs-out.json', methods=['GET', 'OPTIONS'])
@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
def wikipedia_view_refs_outbound_json(wiki_lang: str, wiki_article: str):
    wiki_article = wiki_article.replace('_', ' ')
    wikipedia_article = wiki_lang + ":" + wiki_article
    hits = _refs_web("out", wikipedia_article=wikipedia_article)
    return Response(hits.json(exclude_unset=True), mimetype="application/json")


@app.route('/reference/match.json', methods=['GET', 'OPTIONS'])
@crossdomain(origin='*',headers=['access-control-allow-origin','Content-Type'])
def reference_match_json():
    form = ReferenceMatchForm(request.args)
    if form.validate():
        if form.submit_type.data == 'match':
            matches = close_fuzzy_biblio_matches(es_client=app.es_client, biblio=form.data, match_limit=10) or []
        else:
            raise NotImplementedError()
        resp = []
        for m in matches:
            # expand releases more completely
            m.release = api.get_release(m.release.ident, expand="container,files,filesets,webcaptures", hide="abstract,refs")
            # hack in access options
            m.access_options = release_access_options(m.release)

            # and manually convert to dict (for jsonify)
            info = m.__dict__
            info['release'] = entity_to_dict(m.release)
            info['access_options'] = [o.dict() for o in m.access_options]
            resp.append(info)
        return jsonify(resp), 200
    else:
        return Response(json.dumps(dict(errors=form.errors)), mimetype="application/json", status=400)