repo.py 4.47 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
21
# 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

22
from nomad.files import UploadFiles, Restricted
Markus Scheidgen's avatar
Markus Scheidgen committed
23
24

from .app import api
25
from .auth import login_if_available, create_authorization_predicate
Markus Scheidgen's avatar
Markus Scheidgen committed
26
27
from .common import pagination_model, pagination_request_parser, calc_route

28
ns = api.namespace('repo', description='Access repository metadata.')
Markus Scheidgen's avatar
Markus Scheidgen committed
29
30
31
32
33


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

        Repository metadata only entails the quanties shown in the repository.
43
        Calcs are references via *upload_id*, *calc_id* pairs.
Markus Scheidgen's avatar
Markus Scheidgen committed
44
        """
45
        # TODO use elastic search instead of the files
Markus Scheidgen's avatar
Markus Scheidgen committed
46
        # TODO add missing user metadata (from elastic or repo db)
47
48
49
50
        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
51
        try:
52
53
54
55
            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:
56
            abort(404, message='There is no calculation for %s/%s' % (upload_id, calc_id))
Markus Scheidgen's avatar
Markus Scheidgen committed
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71


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):
72
    @api.doc('get_calcs')
Markus Scheidgen's avatar
Markus Scheidgen committed
73
74
75
76
77
78
79
80
    @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.

81
82
        This is currently not implemented!
        """
83
        return dict(pagination=dict(total=0, page=1, per_page=10), results=[]), 200
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
        # 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':
        #     search = RepoCalc.search().query('match_all')
        # elif owner == 'user':
        #     if g.user is None:
        #         abort(401, message='Authentication required for owner value user.')
        #     search = RepoCalc.search().query('match_all')
        #     search = search.filter('term', user_id=str(g.user.user_id))
        # elif owner == 'staging':
        #     if g.user is None:
        #         abort(401, message='Authentication required for owner value user.')
        #     search = RepoCalc.search().query('match_all')
        #     search = search.filter('term', user_id=str(g.user.user_id)).filter('term', staging=True)
        # else:
        #     abort(400, message='Invalid owner value. Valid values are all|user|staging, default is all')

        # search = search[(page - 1) * per_page: page * per_page]
        # return {
        #     'pagination': {
        #         'total': search.count(),
        #         'page': page,
        #         'per_page': per_page
        #     },
        #     'results': [result.json_dict for result in search]
        # }, 200