archive.py 15 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 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.

15
16
17
18
19
"""
The archive API of the nomad@FAIRDI APIs. This API is about serving processed
(parsed and normalized) calculation data in nomad's *meta-info* format.
"""

20
from typing import Dict, Any
21
from io import BytesIO
22
23
import os.path
from flask import send_file
24
from flask_restplus import abort, Resource, fields
25
import json
26
import importlib
27

28
29
import nomad_meta_info

30
from nomad.files import UploadFiles, Restricted
31
from nomad import utils, search
32

33
from .auth import authenticate, create_authorization_predicate
Markus Scheidgen's avatar
Markus Scheidgen committed
34
from .api import api
35
36
37
from .common import calc_route, streamed_zipfile, search_model, add_pagination_parameters,\
    add_scroll_parameters, add_search_parameters, apply_search_parameters,\
    query_api_python, query_api_curl
38
39

ns = api.namespace(
40
41
    'archive',
    description='Access archive data and archive processing logs.')
42
43
44
45


@calc_route(ns, '/logs')
class ArchiveCalcLogResource(Resource):
46
    @api.doc('get_archive_logs')
47
    @api.response(404, 'The upload or calculation does not exist')
48
    @api.response(401, 'Not authorized to access the data.')
49
    @api.response(200, 'Archive data send', headers={'Content-Type': 'application/plain'})
50
    @authenticate(signature_token=True)
51
    def get(self, upload_id, calc_id):
52
53
54
        """
        Get calculation processing log.

55
        Calcs are references via *upload_id*, *calc_id* pairs.
56
        """
57
        archive_id = '%s/%s' % (upload_id, calc_id)
58

59
        upload_files = UploadFiles.get(
60
            upload_id, is_authorized=create_authorization_predicate(upload_id, calc_id))
61

62
        if upload_files is None:
63
            abort(404, message='Upload %s does not exist.' % upload_id)
64
65
66

        try:
            return send_file(
67
                upload_files.archive_log_file(calc_id, 'rb'),
68
69
                mimetype='text/plain',
                as_attachment=True,
70
                cache_timeout=0,
71
72
                attachment_filename='%s.log' % archive_id)
        except Restricted:
73
            abort(401, message='Not authorized to access %s/%s.' % (upload_id, calc_id))
74
75
        except KeyError:
            abort(404, message='Calculation %s does not exist.' % archive_id)
76
77
78
79


@calc_route(ns)
class ArchiveCalcResource(Resource):
80
    @api.doc('get_archive_calc')
81
    @api.response(404, 'The upload or calculation does not exist')
82
    @api.response(401, 'Not authorized to access the data.')
83
    @api.response(200, 'Archive data send')
84
    @authenticate(signature_token=True)
85
    def get(self, upload_id, calc_id):
86
87
88
        """
        Get calculation data in archive form.

89
        Calcs are references via *upload_id*, *calc_id* pairs.
90
        """
91
        archive_id = '%s/%s' % (upload_id, calc_id)
92

93
        upload_file = UploadFiles.get(
94
            upload_id, is_authorized=create_authorization_predicate(upload_id, calc_id))
95

96
        if upload_file is None:
97
            abort(404, message='Archive %s does not exist.' % upload_id)
98
99
100

        try:
            return send_file(
101
                upload_file.archive_file(calc_id, 'rb'),
102
103
                mimetype='application/json',
                as_attachment=True,
104
                cache_timeout=0,
105
106
                attachment_filename='%s.json' % archive_id)
        except Restricted:
107
            abort(401, message='Not authorized to access %s/%s.' % (upload_id, calc_id))
108
        except KeyError:
109
            abort(404, message='Calculation %s does not exist.' % archive_id)
110
111


112
113
114
_archive_download_parser = api.parser()
add_search_parameters(_archive_download_parser)
_archive_download_parser.add_argument(
115
116
117
    name='compress', type=bool, help='Use compression on .zip files, default is not.',
    location='args')

118
119
120

@ns.route('/download')
class ArchiveDownloadResource(Resource):
121
122
    manifest_quantities = ['upload_id', 'calc_id', 'external_id', 'raw_id', 'pid', 'calc_hash']

123
    @api.doc('archive_download')
124
    @api.response(400, 'Invalid requests, e.g. wrong owner type or bad search parameters')
125
    @api.expect(_archive_download_parser, validate=True)
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
    @api.response(200, 'File(s) send', headers={'Content-Type': 'application/zip'})
    @authenticate(signature_token=True)
    def get(self):
        """
        Get calculation data in archive form from all query results.

        See ``/repo`` endpoint for documentation on the search
        parameters.

        Zip files are streamed; instead of 401 errors, the zip file will just not contain
        any files that the user is not authorized to access.

        The zip file will contain a ``manifest.json`` with the repository meta data.
        """
        try:
141
            args = _archive_download_parser.parse_args()
142
143
144
145
146
            compress = args.get('compress', False)
        except Exception:
            abort(400, message='bad parameter types')

        search_request = search.SearchRequest()
147
        apply_search_parameters(search_request, args)
148

149
        calcs = search_request.execute_scan(order_by='upload_id')
150
151

        def generator():
152
            manifest = {}
Markus Scheidgen's avatar
Markus Scheidgen committed
153
            upload_files = None
154
155
156
            for entry in calcs:
                upload_id = entry['upload_id']
                calc_id = entry['calc_id']
Markus Scheidgen's avatar
Markus Scheidgen committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
                if upload_files is None or upload_files.upload_id != upload_id:
                    if upload_files is not None:
                        upload_files.close_zipfile_cache()

                    upload_files = UploadFiles.get(
                        upload_id, create_authorization_predicate(upload_id))

                    if upload_files is None:
                        utils.get_logger(__name__).error('upload files do not exist', upload_id=upload_id)
                        continue

                    upload_files.open_zipfile_cache()

                yield (
                    '%s.%s' % (calc_id, upload_files._archive_ext), calc_id,
                    lambda calc_id: upload_files.archive_file(calc_id, 'rb'),
                    lambda calc_id: upload_files.archive_file_size(calc_id))
174

175
                manifest[calc_id] = {
176
                    key: entry[key]
177
                    for key in ArchiveDownloadResource.manifest_quantities
178
179
                    if entry.get(key) is not None
                }
180

Markus Scheidgen's avatar
Markus Scheidgen committed
181
182
183
            if upload_files is not None:
                upload_files.close_zipfile_cache()

184
185
186
187
188
189
190
191
192
193
194
195
            try:
                manifest_contents = json.dumps(manifest).encode('utf-8')
            except Exception as e:
                manifest_contents = json.dumps(
                    dict(error='Could not create the manifest: %s' % (e))).encode('utf-8')
                utils.get_logger(__name__).error(
                    'could not create raw query manifest', exc_info=e)

            yield (
                'manifest.json', 'manifest',
                lambda *args: BytesIO(manifest_contents),
                lambda *args: len(manifest_contents))
196

197
198
199
200
        return streamed_zipfile(
            generator(), zipfile_name='nomad_archive.zip', compress=compress)


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
_archive_query_parser = api.parser()
add_pagination_parameters(_archive_query_parser)
add_scroll_parameters(_archive_query_parser)

_archive_query_model_fields = {
    'results': fields.List(fields.Raw, description=(
        'A list of search results. Each result is a dict with quantities names as key and '
        'values as values')),
    'python': fields.String(description=(
        'A string of python code snippet which can be executed to reproduce the api result.')),
    'curl': fields.String(description=(
        'A string of curl command which can be executed to reproduce the api result.')),
}
_archive_query_model = api.inherit('ArchiveCalculations', search_model, _archive_query_model_fields)


217
218
@ns.route('/query')
class ArchiveQueryResource(Resource):
219
    @api.doc('archive_query')
220
    @api.response(400, 'Invalid requests, e.g. wrong owner type or bad search parameters')
221
222
223
224
225
    @api.response(401, 'Not authorized to access the data.')
    @api.response(404, 'The upload or calculation does not exist')
    @api.response(200, 'Archive data send')
    @api.expect(_archive_query_parser, validate=True)
    @api.marshal_with(_archive_query_model, skip_none=True, code=200, description='Search results sent')
226
227
228
229
230
231
232
233
    @authenticate(signature_token=True)
    def get(self):
        """
        Get archive data in json format from all query results.

        See ``/repo`` endpoint for documentation on the search
        parameters.

234
235
        The actual data are in archive_data and a supplementary python code (curl) to
        execute search is in python (curl).
236
237
        """
        try:
238
239
240
241
            args = {
                key: value for key, value in _archive_query_parser.parse_args().items()
                if value is not None}

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
            scroll = args.get('scroll', False)
            scroll_id = args.get('scroll_id', None)
            page = args.get('page', 1)
            per_page = args.get('per_page', 10 if not scroll else 1000)
            order = args.get('order', -1)
            order_by = 'upload_id'
        except Exception:
            abort(400, message='bad parameter types')

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

        if order not in [-1, 1]:
            abort(400, message='invalid pagination')

        search_request = search.SearchRequest()
261
        apply_search_parameters(search_request, _archive_query_parser.parse_args())
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277

        try:
            if scroll:
                results = search_request.execute_scrolled(scroll_id=scroll_id, size=per_page)

            else:
                results = search_request.execute_paginated(
                    per_page=per_page, page=page, order=order, order_by=order_by)

        except search.ScrollIdNotFound:
            abort(400, 'The given scroll_id does not exist.')
        except KeyError as e:
            import traceback
            traceback.print_exc()
            abort(400, str(e))

278
279
280
281
        # build python code and curl snippet
        uri = os.path.join(api.base_url, ns.name, 'query')
        results['python'] = query_api_python(args, uri)
        results['curl'] = query_api_curl(args, uri)
282

283
        data = []
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
        calcs = results['results']
        try:
            upload_files = None
            for entry in calcs:
                upload_id = entry['upload_id']
                calc_id = entry['calc_id']
                if upload_files is None or upload_files.upload_id != upload_id:
                    if upload_files is not None:
                        upload_files.close_zipfile_cache()

                    upload_files = UploadFiles.get(
                        upload_id, create_authorization_predicate(upload_id))

                    if upload_files is None:
                        raise KeyError

                    upload_files.open_zipfile_cache()

                fo = upload_files.archive_file(calc_id, 'rb')
303
                data.append(json.loads(fo.read()))
304
305
306
307
308
309
310
311
312
313

            if upload_files is not None:
                upload_files.close_zipfile_cache()

        except Restricted:
            abort(401, message='Not authorized to access %s/%s.' % (upload_id, calc_id))

        except KeyError:
            abort(404, message='Calculation %s/%s does not exist.' % (upload_id, calc_id))

314
        results['results'] = data
315
316

        return results, 200
317
318


319
320
@ns.route('/metainfo/<string:metainfo_package_name>')
@api.doc(params=dict(metainfo_package_name='The name of the metainfo package.'))
321
322
323
324
class MetainfoResource(Resource):
    @api.doc('get_metainfo')
    @api.response(404, 'The metainfo does not exist')
    @api.response(200, 'Metainfo data send')
325
    def get(self, metainfo_package_name):
326
327
328
329
        """
        Get a metainfo definition file.
        """
        try:
330
            return load_metainfo(metainfo_package_name), 200
331
        except FileNotFoundError:
332
            parser_prefix = metainfo_package_name[:-len('.nomadmetainfo.json')]
333

334
            try:
335
336
337
                return load_metainfo(dict(
                    parser='%sparser' % parser_prefix,
                    path='%s.nomadmetainfo.json' % parser_prefix)), 200
338
339
            except FileNotFoundError:
                abort(404, message='The metainfo %s does not exist.' % metainfo_package_name)
340
341
342
343
344


metainfo_main_path = os.path.dirname(os.path.abspath(nomad_meta_info.__file__))


345
346
347
def load_metainfo(
        package_name_or_dependency: str, dependency_source: str = None,
        loaded_packages: Dict[str, Any] = None) -> Dict[str, Any]:
348
349
350
351
352
    """
    Loads the given metainfo package and all its dependencies. Returns a dict with
    all loaded package_names and respective packages.

    Arguments:
353
354
        package_name_or_dependency: The name of the package, or a nomadmetainfo dependency object.
        dependency_source: The path of the metainfo that uses this function to load a relative dependency.
355
356
357
358
359
360
        loaded_packages: Give a dict and the function will added freshly loaded packages
            to it and return it.
    """
    if loaded_packages is None:
        loaded_packages = {}

361
362
    if isinstance(package_name_or_dependency, str):
        package_name = package_name_or_dependency
363
        metainfo_path = os.path.join(metainfo_main_path, package_name)
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
    else:
        dependency = package_name_or_dependency
        if 'relativePath' in dependency:
            if dependency_source is None:
                raise Exception(
                    'Can only load relative dependency from within another metainfo package')

            metainfo_path = os.path.join(
                os.path.dirname(dependency_source), dependency['relativePath'])

        elif 'metainfoPath' in dependency:
            metainfo_path = os.path.join(metainfo_main_path, dependency['metainfoPath'])

        elif 'parser' in dependency:
            parser = dependency['parser']
            path = dependency['path']
            try:
                parser_module = importlib.import_module(parser).__file__
            except Exception:
                raise Exception('Parser not installed %s for metainfo path %s' % (parser, metainfo_path))

            parser_directory = os.path.dirname(parser_module)
            metainfo_path = os.path.join(parser_directory, path)

        else:
            raise Exception('Invalid dependency type in metainfo package %s' % metainfo_path)

        package_name = os.path.basename(metainfo_path)
392
393
394
395
396
397
398
399
400
401
402
403

    package_name = os.path.basename(package_name)

    if package_name in loaded_packages:
        return loaded_packages

    with open(metainfo_path, 'rt') as f:
        metainfo_json = json.load(f)

    loaded_packages[package_name] = metainfo_json

    for dependency in metainfo_json.get('dependencies', []):
404
        load_metainfo(dependency, dependency_source=metainfo_path, loaded_packages=loaded_packages)
405
406

    return loaded_packages