data.py 28.5 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
22
23
24
25
26
# 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.

"""
This module comprises a set of persistent document classes that hold all user related
data. These are information about users, their uploads and datasets, the associated
calculations, and files


.. autoclass:: Calc
    :members:
.. autoclass:: Upload
    :members:
"""

27
from typing import List, Any, ContextManager, Tuple, Generator, Dict, cast
28
from mongoengine import StringField, DateTimeField, DictField, BooleanField
Markus Scheidgen's avatar
Markus Scheidgen committed
29
import logging
30
from structlog import wrap_logger
31
from contextlib import contextmanager
32
import os.path
33
34
from datetime import datetime
from pymongo import UpdateOne
Markus Scheidgen's avatar
Markus Scheidgen committed
35

36
from nomad import utils, coe_repo, config, infrastructure, search
37
from nomad.files import PathObject, UploadFiles, ExtractError, ArchiveBasedStagingUploadFiles, PublicUploadFiles
38
from nomad.processing.base import Proc, process, task, PENDING, SUCCESS, FAILURE
39
from nomad.parsing import parser_dict, match_parser, LocalBackend
Markus Scheidgen's avatar
Markus Scheidgen committed
40
from nomad.normalizing import normalizers
Markus Scheidgen's avatar
Markus Scheidgen committed
41
from nomad.datamodel import UploadWithMetadata, CalcWithMetadata
Markus Scheidgen's avatar
Markus Scheidgen committed
42
43


Markus Scheidgen's avatar
Markus Scheidgen committed
44
class Calc(Proc):
Markus Scheidgen's avatar
Markus Scheidgen committed
45
46
47
48
49
50
51
52
53
54
    """
    Instances of this class represent calculations. This class manages the elastic
    search index entry, files, and archive for the respective calculation.

    It also contains the calculations processing and its state.

    The attribute list, does not include the various repository properties generated
    while parsing, including ``program_name``, ``program_version``, etc.

    Attributes:
55
        calc_id: the calc_id of this calc
Markus Scheidgen's avatar
Markus Scheidgen committed
56
57
58
        parser: the name of the parser used to process this calc
        upload_id: the id of the upload used to create this calculation
        mainfile: the mainfile (including path in upload) that was used to create this calc
59
60

        metadata: the metadata record wit calc and user metadata, see :class:`CalcWithMetadata`
Markus Scheidgen's avatar
Markus Scheidgen committed
61
    """
62
    calc_id = StringField(primary_key=True)
Markus Scheidgen's avatar
Markus Scheidgen committed
63
64
65
66
    upload_id = StringField()
    mainfile = StringField()
    parser = StringField()

67
68
    metadata = DictField()

Markus Scheidgen's avatar
Markus Scheidgen committed
69
    meta: Any = {
Markus Scheidgen's avatar
Markus Scheidgen committed
70
        'indexes': [
71
            'upload_id', 'mainfile', 'parser', 'tasks_status', 'process_status'
Markus Scheidgen's avatar
Markus Scheidgen committed
72
73
74
75
76
        ]
    }

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
77
        self._parser_backend: LocalBackend = None
78
79
        self._upload: Upload = None
        self._upload_files: ArchiveBasedStagingUploadFiles = None
80
        self._calc_proc_logwriter = None
81
        self._calc_proc_logwriter_ctx: ContextManager = None
Markus Scheidgen's avatar
Markus Scheidgen committed
82
83
84

    @classmethod
    def get(cls, id):
85
        return cls.get_by_id(id, 'calc_id')
Markus Scheidgen's avatar
Markus Scheidgen committed
86

Markus Scheidgen's avatar
Markus Scheidgen committed
87
    @property
88
89
    def mainfile_file(self) -> PathObject:
        return self.upload_files.raw_file_object(self.mainfile)
Markus Scheidgen's avatar
Markus Scheidgen committed
90

91
92
93
94
    @property
    def upload(self) -> 'Upload':
        if not self._upload:
            self._upload = Upload.get(self.upload_id)
95
            self._upload.worker_hostname = self.worker_hostname
96
97
        return self._upload

98
99
100
    @property
    def upload_files(self) -> ArchiveBasedStagingUploadFiles:
        if not self._upload_files:
101
102
            self._upload_files = ArchiveBasedStagingUploadFiles(
                self.upload_id, is_authorized=lambda: True, upload_path=self.upload.upload_path)
103
104
        return self._upload_files

Markus Scheidgen's avatar
Markus Scheidgen committed
105
    def get_logger(self, **kwargs):
106
107
108
109
        """
        Returns a wrapped logger that additionally saves all entries to the calculation
        processing log in the archive.
        """
110
111
112
        logger = super().get_logger()
        logger = logger.bind(
            upload_id=self.upload_id, mainfile=self.mainfile, calc_id=self.calc_id, **kwargs)
113

114
        if self._calc_proc_logwriter_ctx is None:
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
            try:
                self._calc_proc_logwriter_ctx = self.upload_files.archive_log_file(self.calc_id, 'wt')
                self._calc_proc_logwriter = self._calc_proc_logwriter_ctx.__enter__()  # pylint: disable=E1101
            except KeyError:
                # cannot open log file
                pass

        if self._calc_proc_logwriter_ctx is None:
            return logger
        else:
            def save_to_calc_log(logger, method_name, event_dict):
                if self._calc_proc_logwriter is not None:
                    program = event_dict.get('normalizer', 'parser')
                    event = event_dict.get('event', '')
                    entry = '[%s] %s: %s' % (method_name, program, event)
                    if len(entry) > 120:
                        self._calc_proc_logwriter.write(entry[:120])
                        self._calc_proc_logwriter.write('...')
                    else:
                        self._calc_proc_logwriter.write(entry)
                    self._calc_proc_logwriter.write('\n')

                return event_dict

            return wrap_logger(logger, processors=[save_to_calc_log])
140

Markus Scheidgen's avatar
Markus Scheidgen committed
141
    @process
142
    def process_calc(self):
143
        logger = self.get_logger()
144
        if self.upload is None:
145
            logger.error('calculation upload does not exist')
Markus Scheidgen's avatar
Markus Scheidgen committed
146
147

        try:
148
149
150
151
152
153
154
155
156
157
            # save preliminary minimum calc metadata in case processing fails
            # successful processing will replace it with the actual metadata
            calc_with_metadata = CalcWithMetadata(
                upload_id=self.upload_id,
                calc_id=self.calc_id,
                calc_hash=self.upload_files.calc_hash(self.mainfile),
                mainfile=self.mainfile)
            calc_with_metadata.published = False
            calc_with_metadata.uploader = self.upload.uploader.to_popo()
            calc_with_metadata.nomad_version = config.version
158
            calc_with_metadata.nomad_commit = config.commit
159
160
161
162
            calc_with_metadata.last_processing = datetime.now()
            calc_with_metadata.files = self.upload_files.calc_files(self.mainfile)
            self.metadata = calc_with_metadata.to_dict()

Markus Scheidgen's avatar
Markus Scheidgen committed
163
164
165
166
            self.parsing()
            self.normalizing()
            self.archiving()
        finally:
Markus Scheidgen's avatar
Markus Scheidgen committed
167
            # close loghandler that was not closed due to failures
168
            try:
169
170
171
                if self._calc_proc_logwriter is not None:
                    self._calc_proc_logwriter.close()
                    self._calc_proc_logwriter = None
172
173
174
            except Exception as e:
                logger.error('could not close calculation proc log', exc_info=e)

175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
    def fail(self, *errors, log_level=logging.ERROR, **kwargs):
        # in case of failure, index a minimum set of metadata and mark
        # processing failure
        try:
            calc_with_metadata = CalcWithMetadata(**self.metadata)
            calc_with_metadata.formula = config.services.not_processed_value
            calc_with_metadata.basis_set = config.services.not_processed_value
            calc_with_metadata.xc_functional = config.services.not_processed_value
            calc_with_metadata.system = config.services.not_processed_value
            calc_with_metadata.crystal_system = config.services.not_processed_value
            calc_with_metadata.spacegroup = config.services.not_processed_value
            calc_with_metadata.spacegroup_symbol = config.services.not_processed_value
            calc_with_metadata.code_name = config.services.not_processed_value
            calc_with_metadata.code_version = config.services.not_processed_value
            calc_with_metadata.processed = False
            self.metadata = calc_with_metadata.to_dict()
            search.Entry.from_calc_with_metadata(calc_with_metadata).save()
        except Exception as e:
            self.get_logger().error('could not index after processing failure', exc_info=e)

        super().fail(*errors, log_level=log_level, **kwargs)

197
198
199
200
201
202
203
    def on_process_complete(self, process_name):
        # the save might be necessary to correctly read the join condition from the db
        self.save()
        # in case of error, the process_name might be unknown
        if process_name == 'process_calc' or process_name is None:
            self.upload.reload()
            self.upload.check_join()
Markus Scheidgen's avatar
Markus Scheidgen committed
204
205
206

    @task
    def parsing(self):
207
        context = dict(parser=self.parser, step=self.parser)
208
        logger = self.get_logger(**context)
209
        parser = parser_dict[self.parser]
Markus Scheidgen's avatar
Markus Scheidgen committed
210

211
        with utils.timer(logger, 'parser executed', input_size=self.mainfile_file.size):
212
213
214
215
216
217
218
            try:
                self._parser_backend = parser.run(
                    self.upload_files.raw_file_object(self.mainfile).os_path, logger=logger)
            except Exception as e:
                self.fail(
                    'parser failed with exception', level=logging.ERROR,
                    exc_info=e, error=str(e), **context)
219
                return
Markus Scheidgen's avatar
Markus Scheidgen committed
220

221
222
        # add the non code specific calc metadata to the backend
        # all other quantities have been determined by parsers/normalizers
223
224
        self._parser_backend.openNonOverlappingSection('section_calculation_info')
        self._parser_backend.addValue('upload_id', self.upload_id)
225
        self._parser_backend.addValue('calc_id', self.calc_id)
226
        self._parser_backend.addValue('calc_hash', self.metadata['calc_hash'])
227
228
229
        self._parser_backend.addValue('main_file', self.mainfile)
        self._parser_backend.addValue('parser_name', self.parser)

Markus Scheidgen's avatar
Markus Scheidgen committed
230
        if self._parser_backend.status[0] != 'ParseSuccess':
231
            logger.error(self._parser_backend.status[1])
Markus Scheidgen's avatar
Markus Scheidgen committed
232
            error = self._parser_backend.status[1]
233
            self._parser_backend.addValue('parse_status', 'ParseFailure')
234
            self.fail(error, level=logging.INFO, **context)
235
236
237
238
239
        else:
            self._parser_backend.addValue('parse_status', 'ParseSuccess')

        self._parser_backend.closeNonOverlappingSection('section_calculation_info')

240
241
        self._parser_backend.openNonOverlappingSection('section_repository_info')
        self._parser_backend.addValue('repository_archive_gid', '%s/%s' % (self.upload_id, self.calc_id))
242
        self._parser_backend.addValue('repository_filepaths', self.metadata['files'])
243
244
        self._parser_backend.closeNonOverlappingSection('section_repository_info')

245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
        self.add_processor_info(self.parser)

    @contextmanager
    def use_parser_backend(self, processor_name):
        self._parser_backend.reset_status()
        yield self._parser_backend
        self.add_processor_info(processor_name)

    def add_processor_info(self, processor_name: str) -> None:
        self._parser_backend.openContext('/section_calculation_info/0')
        self._parser_backend.openNonOverlappingSection('section_archive_processing_info')
        self._parser_backend.addValue('archive_processor_name', processor_name)

        if self._parser_backend.status[0] == 'ParseSuccess':
            warnings = getattr(self._parser_backend, '_warnings', [])
            if len(warnings) > 0:
                self._parser_backend.addValue('archive_processor_status', 'WithWarnings')
                self._parser_backend.addValue('archive_processor_warning_number', len(warnings))
                self._parser_backend.addArrayValues('archive_processor_warnings', [str(warning) for warning in warnings])
            else:
                self._parser_backend.addValue('archive_processor_status', 'Success')
        else:
267
            errors = self._parser_backend.status[1]
268
269
270
271
            self._parser_backend.addValue('archive_processor_error', str(errors))

        self._parser_backend.closeNonOverlappingSection('section_archive_processing_info')
        self._parser_backend.closeContext('/section_calculation_info/0')
Markus Scheidgen's avatar
Markus Scheidgen committed
272
273
274
275
276

    @task
    def normalizing(self):
        for normalizer in normalizers:
            normalizer_name = normalizer.__name__
277
            context = dict(normalizer=normalizer_name, step=normalizer_name)
278
            logger = self.get_logger(**context)
Markus Scheidgen's avatar
Markus Scheidgen committed
279
280

            with utils.timer(
281
                    logger, 'normalizer executed', input_size=self.mainfile_file.size):
282
                with self.use_parser_backend(normalizer_name) as backend:
283
284
285
286
287
288
289
                    try:
                        normalizer(backend).normalize(logger=logger)
                    except Exception as e:
                        self.fail(
                            'normalizer failed with exception', level=logging.ERROR,
                            exc_info=e, error=str(e), **context)
                        self._parser_backend.status = ['ParseFailure', str(e)]
Markus Scheidgen's avatar
Markus Scheidgen committed
290

291
292
            failed = self._parser_backend.status[0] != 'ParseSuccess'
            if failed:
293
                logger.error(self._parser_backend.status[1])
Markus Scheidgen's avatar
Markus Scheidgen committed
294
                error = self._parser_backend.status[1]
295
                self.fail(error, level=logging.WARNING, error=error, **context)
296
297
298
299
                break
            else:
                logger.debug(
                    'completed normalizer successfully', normalizer=normalizer_name)
Markus Scheidgen's avatar
Markus Scheidgen committed
300
301
302

    @task
    def archiving(self):
303
304
        logger = self.get_logger()

305
306
        calc_with_metadata = CalcWithMetadata(**self.metadata)
        calc_with_metadata.apply_domain_metadata(self._parser_backend)
307
        calc_with_metadata.parser_name = self.parser
308
        calc_with_metadata.processed = True
309

310
311
        # persist the calc metadata
        with utils.timer(logger, 'saved calc metadata', step='metadata'):
312
            self.metadata = calc_with_metadata.to_dict()
313
314

        # index in search
315
        with utils.timer(logger, 'indexed', step='index'):
316
            search.Entry.from_calc_with_metadata(calc_with_metadata).save()
317

318
        # persist the archive
Markus Scheidgen's avatar
Markus Scheidgen committed
319
        with utils.timer(
320
                logger, 'archived', step='archive',
Markus Scheidgen's avatar
Markus Scheidgen committed
321
                input_size=self.mainfile_file.size) as log_data:
322
            with self.upload_files.archive_file(self.calc_id, 'wt') as out:
323
324
                self._parser_backend.write_json(out, pretty=True)

325
            log_data.update(archive_size=self.upload_files.archive_file_object(self.calc_id).size)
Markus Scheidgen's avatar
Markus Scheidgen committed
326
327
328
329

        # close loghandler
        if self._calc_proc_logwriter is not None:
            with utils.timer(
330
                    logger, 'archived log', step='logs',
Markus Scheidgen's avatar
Markus Scheidgen committed
331
                    input_size=self.mainfile_file.size) as log_data:
332
                self._calc_proc_logwriter_ctx.__exit__(None, None, None)  # pylint: disable=E1101
333
                self._calc_proc_logwriter = None
Markus Scheidgen's avatar
Markus Scheidgen committed
334

335
                log_data.update(log_size=self.upload_files.archive_log_file_object(self.calc_id).size)
Markus Scheidgen's avatar
Markus Scheidgen committed
336

337
    def __str__(self):
338
        return 'calc %s calc_id=%s upload_id%s' % (super().__str__(), self.calc_id, self.upload_id)
339

340

341
class Upload(Proc):
Markus Scheidgen's avatar
Markus Scheidgen committed
342
343
344
345
346
347
    """
    Represents uploads in the databases. Provides persistence access to the files storage,
    and processing state.

    Attributes:
        name: optional user provided upload name
348
349
        upload_path: the path were the uploaded files was stored
        temporary: True if the uploaded file should be removed after extraction
350
        metadata: optional user provided additional meta data
Markus Scheidgen's avatar
Markus Scheidgen committed
351
352
        upload_id: the upload id generated by the database
        upload_time: the timestamp when the system realised the upload
353
        user_id: the id of the user that created this upload
Markus Scheidgen's avatar
Markus Scheidgen committed
354
355
356
357
    """
    id_field = 'upload_id'

    upload_id = StringField(primary_key=True)
358
359
    upload_path = StringField(default=None)
    temporary = BooleanField(default=False)
Markus Scheidgen's avatar
Markus Scheidgen committed
360
361

    name = StringField(default=None)
362
    metadata = DictField(default=None)
Markus Scheidgen's avatar
Markus Scheidgen committed
363
    upload_time = DateTimeField()
364
    user_id = StringField(required=True)
365
366
    published = BooleanField(default=False)
    publish_time = DateTimeField()
Markus Scheidgen's avatar
Markus Scheidgen committed
367
368
369

    meta: Any = {
        'indexes': [
370
            'user_id', 'tasks_status', 'process_status', 'published'
Markus Scheidgen's avatar
Markus Scheidgen committed
371
372
373
374
375
        ]
    }

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
376
        self._upload_files: ArchiveBasedStagingUploadFiles = None
Markus Scheidgen's avatar
Markus Scheidgen committed
377
378

    @classmethod
379
380
381
382
383
384
385
    def get(cls, id: str, include_published: bool = False) -> 'Upload':
        upload = cls.get_by_id(id, 'upload_id')
        # TODO published uploads should not be hidden by this and API
        if upload is not None and (not upload.published or include_published):
            return upload

        raise KeyError()
Markus Scheidgen's avatar
Markus Scheidgen committed
386
387

    @classmethod
388
    def user_uploads(cls, user: coe_repo.User) -> List['Upload']:
Markus Scheidgen's avatar
Markus Scheidgen committed
389
        """ Returns all uploads for the given user. Currently returns all uploads. """
390
        return cls.objects(user_id=str(user.user_id), published=False)
Markus Scheidgen's avatar
Markus Scheidgen committed
391

392
393
394
395
    @property
    def uploader(self):
        return coe_repo.User.from_user_id(self.user_id)

Markus Scheidgen's avatar
Markus Scheidgen committed
396
397
    def get_logger(self, **kwargs):
        logger = super().get_logger()
398
        logger = logger.bind(upload_id=self.upload_id, upload_name=self.name, **kwargs)
Markus Scheidgen's avatar
Markus Scheidgen committed
399
400
401
402
403
404
405
406
        return logger

    @classmethod
    def create(cls, **kwargs) -> 'Upload':
        """
        Creates a new upload for the given user, a user given name is optional.
        It will populate the record with a signed url and pending :class:`UploadProc`.
        The upload will be already saved to the database.
407
408

        Arguments:
409
            user (coe_repo.User): The user that created the upload.
Markus Scheidgen's avatar
Markus Scheidgen committed
410
        """
411
        user: coe_repo.User = kwargs['user']
412
413
414
        del(kwargs['user'])
        if 'upload_id' not in kwargs:
            kwargs.update(upload_id=utils.create_uuid())
415
        kwargs.update(user_id=str(user.user_id))
Markus Scheidgen's avatar
Markus Scheidgen committed
416
        self = super().create(**kwargs)
417

Markus Scheidgen's avatar
Markus Scheidgen committed
418
        self._continue_with('uploading')
419

Markus Scheidgen's avatar
Markus Scheidgen committed
420
421
        return self

422
423
424
425
426
427
428
429
430
431
432
433
434
435
    def delete(self):
        """ Deletes this upload process state entry and its calcs. """
        Calc.objects(upload_id=self.upload_id).delete()
        super().delete()

    @process
    def delete_upload(self):
        """
        Deletes of the upload, including its processing state and
        staging files.
        """
        logger = self.get_logger()

        with utils.lnr(logger, 'staged upload delete failed'):
436
437
438
439
440
441

            with utils.timer(
                    logger, 'upload deleted from repo db', step='repo',
                    upload_size=self.upload_files.size):
                coe_repo.Upload.delete(self.upload_id)

442
            with utils.timer(
443
                    logger, 'upload deleted from index', step='index',
444
                    upload_size=self.upload_files.size):
445
                search.delete_upload(self.upload_id)
446

447
            with utils.timer(
448
                    logger, 'staged upload deleted', step='files',
449
450
451
452
453
                    upload_size=self.upload_files.size):
                self.upload_files.delete()
                self.delete()

        return True  # do not save the process status on the delete upload
454

455
    @process
456
    def publish_upload(self):
457
458
459
460
461
462
        """
        Moves the upload out of staging to add it to the coe repository. It will
        pack the staging upload files in to public upload files, add entries to the
        coe repository db and remove this instance and its calculation from the
        processing state db.
        """
463
464
        assert self.processed_calcs > 0

465
        logger = self.get_logger()
466
        logger.info('started to publish')
467

468
        with utils.lnr(logger, 'publish failed'):
469
470
            upload_with_metadata = self.to_upload_with_metadata()

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
            if config.repository_db.publish_enabled:
                with utils.timer(
                        logger, 'upload added to repository', step='repo',
                        upload_size=self.upload_files.size):
                    coe_repo.Upload.publish(upload_with_metadata)

            if config.repository_db.publish_enabled:
                coe_upload = coe_repo.Upload.from_upload_id(upload_with_metadata.upload_id)
                if coe_upload is not None:
                    calcs = [coe_calc.to_calc_with_metadata() for coe_calc in coe_upload.calcs]
                else:
                    calcs = []
            else:
                calcs = upload_with_metadata.calcs

486
            with utils.timer(
487
                    logger, 'upload metadata updated', step='metadata',
488
                    upload_size=self.upload_files.size):
489
490

                def create_update(calc):
491
                    calc.published = True
492
493
494
495
496
                    return UpdateOne(
                        {'_id': calc.calc_id},
                        {'$set': {'metadata': calc.to_dict()}})

                Calc._get_collection().bulk_write([create_update(calc) for calc in calcs])
497

498
499
500
            with utils.timer(
                    logger, 'staged upload files packed', step='pack',
                    upload_size=self.upload_files.size):
501
                self.upload_files.pack(upload_with_metadata)
502
503
504
505

            with utils.timer(
                    logger, 'index updated', step='index',
                    upload_size=self.upload_files.size):
506
                search.publish(calcs)
507
508
509
510
511

            with utils.timer(
                    logger, 'staged upload deleted', step='delete staged',
                    upload_size=self.upload_files.size):
                self.upload_files.delete()
512
513
514
                self.published = True
                self.publish_time = datetime.now()
                self.save()
515

Markus Scheidgen's avatar
Markus Scheidgen committed
516
    @process
517
    def process_upload(self):
Markus Scheidgen's avatar
Markus Scheidgen committed
518
519
520
521
522
523
524
        self.extracting()
        self.parse_all()

    @task
    def uploading(self):
        pass

525
    @property
526
527
528
529
530
    def upload_files(self) -> UploadFiles:
        upload_files_class = ArchiveBasedStagingUploadFiles if not self.published else PublicUploadFiles

        if not self._upload_files or not isinstance(self._upload_files, upload_files_class):
            self._upload_files = upload_files_class(
531
                self.upload_id, is_authorized=lambda: True, upload_path=self.upload_path)
532

533
        return self._upload_files
534

535
536
537
538
539
    @property
    def staging_upload_files(self) -> ArchiveBasedStagingUploadFiles:
        assert not self.published
        return cast(ArchiveBasedStagingUploadFiles, self.upload_files)

Markus Scheidgen's avatar
Markus Scheidgen committed
540
541
    @task
    def extracting(self):
542
543
544
545
546
        """
        Task performed before the actual parsing/normalizing. Extracting and bagging
        the uploaded files, computing all keys, create an *upload* entry in the NOMAD-coe
        repository db, etc.
        """
547
548
549
550
551
        # extract the uploaded file
        self._upload_files = ArchiveBasedStagingUploadFiles(
            upload_id=self.upload_id, is_authorized=lambda: True, create=True,
            upload_path=self.upload_path)

Markus Scheidgen's avatar
Markus Scheidgen committed
552
553
        logger = self.get_logger()
        try:
Markus Scheidgen's avatar
Markus Scheidgen committed
554
555
            with utils.timer(
                    logger, 'upload extracted', step='extracting',
556
557
                    upload_size=self.upload_files.size):
                self.upload_files.extract()
558
559
560
561

            if self.temporary:
                os.remove(self.upload_path)
                self.upload_path = None
562

563
        except KeyError:
564
            self.fail('processing requested for non existing upload', log_level=logging.ERROR)
565
566
567
            return
        except ExtractError:
            self.fail('bad .zip/.tar file', log_level=logging.INFO)
Markus Scheidgen's avatar
Markus Scheidgen committed
568
569
            return

570
    def match_mainfiles(self) -> Generator[Tuple[str, object], None, None]:
571
572
573
574
575
576
577
        """
        Generator function that matches all files in the upload to all parsers to
        determine the upload's mainfiles.

        Returns:
            Tuples of mainfile, filename, and parsers
        """
578
        directories_with_match: Dict[str, str] = dict()
579
580
        upload_files = self.staging_upload_files
        for filename in upload_files.raw_file_manifest():
581
            try:
582
                parser = match_parser(filename, upload_files)
583
                if parser is not None:
584
585
                    directory = os.path.dirname(filename)
                    if directory in directories_with_match:
586
587
588
                        # TODO this might give us the chance to store directory based relationship
                        # between calcs for the future?
                        pass
589
590
                    else:
                        directories_with_match[directory] = filename
591
592

                    yield filename, parser
593
594
595
596
            except Exception as e:
                self.get_logger().error(
                    'exception while matching pot. mainfile',
                    mainfile=filename, exc_info=e)
597

Markus Scheidgen's avatar
Markus Scheidgen committed
598
599
    @task
    def parse_all(self):
600
        """
601
        Identified mainfile/parser combinations among the upload's files, creates
602
603
        respective :class:`Calc` instances, and triggers their processing.
        """
604
605
        logger = self.get_logger()

Markus Scheidgen's avatar
Markus Scheidgen committed
606
607
        with utils.timer(
                logger, 'upload extracted', step='matching',
608
609
                upload_size=self.upload_files.size):
            for filename, parser in self.match_mainfiles():
610
                calc = Calc.create(
611
                    calc_id=self.upload_files.calc_id(filename),
612
                    mainfile=filename, parser=parser.name,
613
                    worker_hostname=self.worker_hostname,
614
615
                    upload_id=self.upload_id)

616
                calc.process_calc()
Markus Scheidgen's avatar
Markus Scheidgen committed
617

618
619
620
621
622
623
624
625
626
627
628
629
    def on_process_complete(self, process_name):
        if process_name == 'process_upload':
            self.check_join()

    def check_join(self):
        total_calcs = self.total_calcs
        processed_calcs = self.processed_calcs

        self.get_logger().debug('check join', processed_calcs=processed_calcs, total_calcs=total_calcs)
        if not self.process_running and processed_calcs >= total_calcs:
            self.get_logger().debug('join')
            self.join()
630
631
632

    def join(self):
        self.cleanup()
Markus Scheidgen's avatar
Markus Scheidgen committed
633
634
635

    @task
    def cleanup(self):
636
637
        search.refresh()

638
639
640
641
642
643
644
645
        # send email about process finish
        user = self.uploader
        name = '%s %s' % (user.first_name, user.last_name)
        message = '\n'.join([
            'Dear %s,' % name,
            '',
            'your data %suploaded %s has completed processing.' % (
                self.name if self.name else '', self.upload_time.isoformat()),
Markus Scheidgen's avatar
Markus Scheidgen committed
646
            'You can review your data on your upload page: %s/uploads' % config.api_url()[:-3]
647
        ])
648
649
650
651
652
653
654
        try:
            infrastructure.send_mail(
                name=name, email=user.email, message=message, subject='Processing completed')
        except Exception as e:
            # probably due to email configuration problems
            # don't fail or present this error to clients
            self.logger.error('could not send after processing email', exc_info=e)
Markus Scheidgen's avatar
Markus Scheidgen committed
655

656
657
658
    def get_calc(self, calc_id) -> Calc:
        return Calc.objects(upload_id=self.upload_id, calc_id=calc_id).first()

Markus Scheidgen's avatar
Markus Scheidgen committed
659
    @property
660
    def processed_calcs(self):
661
        return Calc.objects(upload_id=self.upload_id, tasks_status__in=[SUCCESS, FAILURE]).count()
662
663
664
665
666
667
668

    @property
    def total_calcs(self):
        return Calc.objects(upload_id=self.upload_id).count()

    @property
    def failed_calcs(self):
669
        return Calc.objects(upload_id=self.upload_id, tasks_status=FAILURE).count()
670

671
672
    @property
    def pending_calcs(self):
673
        return Calc.objects(upload_id=self.upload_id, tasks_status=PENDING).count()
674

675
676
    def all_calcs(self, start, end, order_by='mainfile'):
        return Calc.objects(upload_id=self.upload_id)[start:end].order_by(order_by)
677
678
679

    @property
    def calcs(self):
Markus Scheidgen's avatar
Markus Scheidgen committed
680
        return Calc.objects(upload_id=self.upload_id, tasks_status=SUCCESS)
Markus Scheidgen's avatar
Markus Scheidgen committed
681
682

    def to_upload_with_metadata(self) -> UploadWithMetadata:
683
684
685
686
        # prepare user metadata per upload and per calc
        calc_metadatas: Dict[str, Any] = dict()
        upload_metadata: Dict[str, Any] = dict()

Markus Scheidgen's avatar
Markus Scheidgen committed
687
        if self.metadata is not None:
688
689
690
            upload_metadata.update(self.metadata)
            if 'calculations' in upload_metadata:
                del(upload_metadata['calculations'])
Markus Scheidgen's avatar
Markus Scheidgen committed
691

692
693
            for calc in self.metadata.get('calculations', []):
                calc_metadatas[calc['mainfile']] = calc
Markus Scheidgen's avatar
Markus Scheidgen committed
694

695
        user_upload_time = upload_metadata.get('_upload_time', None)
Markus Scheidgen's avatar
Markus Scheidgen committed
696
697
698
699
700
        result = UploadWithMetadata(
            upload_id=self.upload_id,
            uploader=utils.POPO(id=int(self.user_id)),
            upload_time=self.upload_time if user_upload_time is None else user_upload_time)

701
702
703
704
705
        def get_metadata(calc: Calc):
            """
            Assemble metadata from calc's processed calc metadata and the uploads
            user metadata.
            """
706
            calc_data = calc.metadata
707
            calc_with_metadata = CalcWithMetadata(**calc_data)
708
709
            calc_metadata = dict(upload_metadata)
            calc_metadata.update(calc_metadatas.get(calc.mainfile, {}))
710
711
712
713
            calc_with_metadata.apply_user_metadata(calc_metadata)

            return calc_with_metadata

714
        result.calcs = [get_metadata(calc) for calc in Calc.objects(upload_id=self.upload_id)]
715

Markus Scheidgen's avatar
Markus Scheidgen committed
716
        return result
717
718

    def __str__(self):
719
        return 'upload %s upload_id%s' % (super().__str__(), self.upload_id)