repo.py 4.52 KB
Newer Older
Markus Scheidgen's avatar
Markus Scheidgen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Copyright 2018 Markus Scheidgen
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an"AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
The repository API of the nomad@FAIRDI APIs. Currently allows to resolve repository
meta-data.
"""

from flask_restplus import Resource, abort, fields
21
22
from flask import request, g
from elasticsearch_dsl import Q
Markus Scheidgen's avatar
Markus Scheidgen committed
23

24
from nomad.files import UploadFiles, Restricted
25
from nomad.search import Entry
Markus Scheidgen's avatar
Markus Scheidgen committed
26
27

from .app import api
28
from .auth import login_if_available, create_authorization_predicate
Markus Scheidgen's avatar
Markus Scheidgen committed
29
30
from .common import pagination_model, pagination_request_parser, calc_route

31
ns = api.namespace('repo', description='Access repository metadata.')
Markus Scheidgen's avatar
Markus Scheidgen committed
32
33
34
35
36


@calc_route(ns)
class RepoCalcResource(Resource):
    @api.response(404, 'The upload or calculation does not exist')
37
    @api.response(401, 'Not authorized to access the calculation')
38
    @api.response(200, 'Metadata send', fields.Raw)
39
    @api.doc('get_repo_calc')
40
    @login_if_available
41
    def get(self, upload_id, calc_id):
Markus Scheidgen's avatar
Markus Scheidgen committed
42
43
44
45
        """
        Get calculation metadata in repository form.

        Repository metadata only entails the quanties shown in the repository.
46
        Calcs are references via *upload_id*, *calc_id* pairs.
Markus Scheidgen's avatar
Markus Scheidgen committed
47
        """
48
        # TODO use elastic search instead of the files
Markus Scheidgen's avatar
Markus Scheidgen committed
49
        # TODO add missing user metadata (from elastic or repo db)
50
51
52
53
        upload_files = UploadFiles.get(upload_id, create_authorization_predicate(upload_id, calc_id))
        if upload_files is None:
            abort(404, message='There is no upload %s' % upload_id)

Markus Scheidgen's avatar
Markus Scheidgen committed
54
        try:
55
56
57
58
            return upload_files.metadata.get(calc_id), 200
        except Restricted:
            abort(401, message='Not authorized to access %s/%s.' % (upload_id, calc_id))
        except KeyError:
59
            abort(404, message='There is no calculation for %s/%s' % (upload_id, calc_id))
Markus Scheidgen's avatar
Markus Scheidgen committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74


repo_calcs_model = api.model('RepoCalculations', {
    'pagination': fields.Nested(pagination_model),
    'results': fields.List(fields.Raw)
})

repo_request_parser = pagination_request_parser.copy()
repo_request_parser.add_argument(
    'owner', type=str,
    help='Specify which calcs to return: ``all``, ``user``, ``staging``, default is ``all``')


@ns.route('/')
class RepoCalcsResource(Resource):
75
    @api.doc('get_calcs')
Markus Scheidgen's avatar
Markus Scheidgen committed
76
77
78
79
80
81
82
83
    @api.response(400, 'Invalid requests, e.g. wrong owner type')
    @api.expect(repo_request_parser, validate=True)
    @api.marshal_with(repo_calcs_model, skip_none=True, code=200, description='Metadata send')
    @login_if_available
    def get(self):
        """
        Get *'all'* calculations in repository from, paginated.

84
85
        This is currently not implemented!
        """
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
        # return dict(pagination=dict(total=0, page=1, per_page=10), results=[]), 200

        page = int(request.args.get('page', 1))
        per_page = int(request.args.get('per_page', 10))
        owner = request.args.get('owner', 'all')

        try:
            assert page >= 1
            assert per_page > 0
        except AssertionError:
            abort(400, message='invalid pagination')

        if owner == 'all':
            if g.user is None:
                q = Q('term', published=True)
            else:
102
                q = Q('term', published=True) | Q('term', owners__user_id=g.user.user_id)
103
104
105
106
        elif owner == 'user':
            if g.user is None:
                abort(401, message='Authentication required for owner value user.')

107
            q = Q('term', owners__user_id=g.user.user_id)
108
109
110
        elif owner == 'staging':
            if g.user is None:
                abort(401, message='Authentication required for owner value user.')
111
            q = Q('term', published=False) & Q('term', owners__user_id=g.user.user_id)
112
113
114
115
116
117
118
119
120
121
122
123
124
        else:
            abort(400, message='Invalid owner value. Valid values are all|user|staging, default is all')

        search = Entry.search().query(q)
        search = search[(page - 1) * per_page: page * per_page]
        return {
            'pagination': {
                'total': search.count(),
                'page': page,
                'per_page': per_page
            },
            'results': [hit.to_dict() for hit in search]
        }, 200