data.py 28.8 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
41
from nomad.datamodel import UploadWithMetadata, CalcWithMetadata, Domain
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
    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_version = config.services.not_processed_value
188
189
190
191
192
193
194

            calc_with_metadata.code_name = config.services.not_processed_value
            if self.parser is not None:
                parser = parser_dict[self.parser]
                if hasattr(parser, 'code_name'):
                    calc_with_metadata.code_name = parser.code_name

195
196
197
198
199
200
201
202
            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)

203
204
205
206
207
208
209
    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
210
211
212

    @task
    def parsing(self):
213
        context = dict(parser=self.parser, step=self.parser)
214
        logger = self.get_logger(**context)
215
        parser = parser_dict[self.parser]
216
        self.metadata['parser_name'] = self.parser
Markus Scheidgen's avatar
Markus Scheidgen committed
217

218
        with utils.timer(logger, 'parser executed', input_size=self.mainfile_file.size):
219
220
221
222
223
224
225
            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)
226
                return
Markus Scheidgen's avatar
Markus Scheidgen committed
227

228
229
        # add the non code specific calc metadata to the backend
        # all other quantities have been determined by parsers/normalizers
230
        self._parser_backend.openNonOverlappingSection('section_entry_info')
231
        self._parser_backend.addValue('upload_id', self.upload_id)
232
        self._parser_backend.addValue('calc_id', self.calc_id)
233
        self._parser_backend.addValue('calc_hash', self.metadata['calc_hash'])
234
        self._parser_backend.addValue('mainfile', self.mainfile)
235
        self._parser_backend.addValue('parser_name', self.parser)
236
237
238
239
240
241
242
243
244
245
246
247
        filepaths = self.metadata['files']
        self._parser_backend.addValue('number_of_files', len(filepaths))
        self._parser_backend.addValue('filepaths', filepaths)
        uploader = self.upload.uploader
        self._parser_backend.addValue(
            'entry_uploader_name', '%s, %s' % (uploader.first_name, uploader.last_name))
        self._parser_backend.addValue(
            'entry_uploader_id', str(uploader.user_id))
        self._parser_backend.addValue('entry_upload_time', int(self.upload.upload_time.timestamp()))
        self._parser_backend.closeNonOverlappingSection('section_entry_info')

        self.add_processor_info(self.parser)
248

Markus Scheidgen's avatar
Markus Scheidgen committed
249
        if self._parser_backend.status[0] != 'ParseSuccess':
250
            logger.error(self._parser_backend.status[1])
Markus Scheidgen's avatar
Markus Scheidgen committed
251
            error = self._parser_backend.status[1]
252
            self.fail(error, level=logging.INFO, **context)
253
254
255
256
257
258
259
260

    @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:
261
        self._parser_backend.openContext('/section_entry_info/0')
262
263
264
265
266
267
268
        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')
269
                self._parser_backend.addValue('number_of_archive_processor_warnings', len(warnings))
270
271
272
273
                self._parser_backend.addArrayValues('archive_processor_warnings', [str(warning) for warning in warnings])
            else:
                self._parser_backend.addValue('archive_processor_status', 'Success')
        else:
274
            errors = self._parser_backend.status[1]
275
276
277
            self._parser_backend.addValue('archive_processor_error', str(errors))

        self._parser_backend.closeNonOverlappingSection('section_archive_processing_info')
278
        self._parser_backend.closeContext('/section_entry_info/0')
Markus Scheidgen's avatar
Markus Scheidgen committed
279
280
281
282

    @task
    def normalizing(self):
        for normalizer in normalizers:
283
284
285
            if normalizer.domain != config.domain:
                continue

Markus Scheidgen's avatar
Markus Scheidgen committed
286
            normalizer_name = normalizer.__name__
287
            context = dict(normalizer=normalizer_name, step=normalizer_name)
288
            logger = self.get_logger(**context)
Markus Scheidgen's avatar
Markus Scheidgen committed
289
290

            with utils.timer(
291
                    logger, 'normalizer executed', input_size=self.mainfile_file.size):
292
                with self.use_parser_backend(normalizer_name) as backend:
293
294
295
296
297
298
299
                    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
300

301
302
            failed = self._parser_backend.status[0] != 'ParseSuccess'
            if failed:
303
                logger.error(self._parser_backend.status[1])
Markus Scheidgen's avatar
Markus Scheidgen committed
304
                error = self._parser_backend.status[1]
305
                self.fail(error, level=logging.WARNING, error=error, **context)
306
307
308
309
                break
            else:
                logger.debug(
                    'completed normalizer successfully', normalizer=normalizer_name)
Markus Scheidgen's avatar
Markus Scheidgen committed
310
311
312

    @task
    def archiving(self):
313
314
        logger = self.get_logger()

315
316
        calc_with_metadata = CalcWithMetadata(**self.metadata)
        calc_with_metadata.apply_domain_metadata(self._parser_backend)
317
        calc_with_metadata.processed = True
318

319
320
        # persist the calc metadata
        with utils.timer(logger, 'saved calc metadata', step='metadata'):
321
            self.metadata = calc_with_metadata.to_dict()
322
323

        # index in search
324
        with utils.timer(logger, 'indexed', step='index'):
325
            search.Entry.from_calc_with_metadata(calc_with_metadata).save()
326

327
        # persist the archive
Markus Scheidgen's avatar
Markus Scheidgen committed
328
        with utils.timer(
329
                logger, 'archived', step='archive',
Markus Scheidgen's avatar
Markus Scheidgen committed
330
                input_size=self.mainfile_file.size) as log_data:
331
            with self.upload_files.archive_file(self.calc_id, 'wt') as out:
332
                self._parser_backend.write_json(out, pretty=True, root_sections=Domain.instance.root_sections)
333

334
            log_data.update(archive_size=self.upload_files.archive_file_object(self.calc_id).size)
Markus Scheidgen's avatar
Markus Scheidgen committed
335
336
337
338

        # close loghandler
        if self._calc_proc_logwriter is not None:
            with utils.timer(
339
                    logger, 'archived log', step='logs',
Markus Scheidgen's avatar
Markus Scheidgen committed
340
                    input_size=self.mainfile_file.size) as log_data:
341
                self._calc_proc_logwriter_ctx.__exit__(None, None, None)  # pylint: disable=E1101
342
                self._calc_proc_logwriter = None
Markus Scheidgen's avatar
Markus Scheidgen committed
343

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

346
    def __str__(self):
347
        return 'calc %s calc_id=%s upload_id%s' % (super().__str__(), self.calc_id, self.upload_id)
348

349

350
class Upload(Proc):
Markus Scheidgen's avatar
Markus Scheidgen committed
351
352
353
354
355
356
    """
    Represents uploads in the databases. Provides persistence access to the files storage,
    and processing state.

    Attributes:
        name: optional user provided upload name
357
358
        upload_path: the path were the uploaded files was stored
        temporary: True if the uploaded file should be removed after extraction
359
        metadata: optional user provided additional meta data
Markus Scheidgen's avatar
Markus Scheidgen committed
360
361
        upload_id: the upload id generated by the database
        upload_time: the timestamp when the system realised the upload
362
        user_id: the id of the user that created this upload
Markus Scheidgen's avatar
Markus Scheidgen committed
363
364
365
366
    """
    id_field = 'upload_id'

    upload_id = StringField(primary_key=True)
367
368
    upload_path = StringField(default=None)
    temporary = BooleanField(default=False)
Markus Scheidgen's avatar
Markus Scheidgen committed
369
370

    name = StringField(default=None)
371
    metadata = DictField(default=None)
Markus Scheidgen's avatar
Markus Scheidgen committed
372
    upload_time = DateTimeField()
373
    user_id = StringField(required=True)
374
375
    published = BooleanField(default=False)
    publish_time = DateTimeField()
Markus Scheidgen's avatar
Markus Scheidgen committed
376
377
378

    meta: Any = {
        'indexes': [
379
            'user_id', 'tasks_status', 'process_status', 'published'
Markus Scheidgen's avatar
Markus Scheidgen committed
380
381
382
383
384
        ]
    }

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
385
        self._upload_files: ArchiveBasedStagingUploadFiles = None
Markus Scheidgen's avatar
Markus Scheidgen committed
386
387

    @classmethod
388
389
390
391
392
393
394
    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
395
396

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

401
402
403
404
    @property
    def uploader(self):
        return coe_repo.User.from_user_id(self.user_id)

Markus Scheidgen's avatar
Markus Scheidgen committed
405
406
    def get_logger(self, **kwargs):
        logger = super().get_logger()
407
        logger = logger.bind(upload_id=self.upload_id, upload_name=self.name, **kwargs)
Markus Scheidgen's avatar
Markus Scheidgen committed
408
409
410
411
412
413
414
415
        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.
416
417

        Arguments:
418
            user (coe_repo.User): The user that created the upload.
Markus Scheidgen's avatar
Markus Scheidgen committed
419
        """
420
        user: coe_repo.User = kwargs['user']
421
422
423
        del(kwargs['user'])
        if 'upload_id' not in kwargs:
            kwargs.update(upload_id=utils.create_uuid())
424
        kwargs.update(user_id=str(user.user_id))
Markus Scheidgen's avatar
Markus Scheidgen committed
425
        self = super().create(**kwargs)
426

Markus Scheidgen's avatar
Markus Scheidgen committed
427
        self._continue_with('uploading')
428

Markus Scheidgen's avatar
Markus Scheidgen committed
429
430
        return self

431
432
433
434
435
436
437
438
439
440
441
442
443
444
    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'):
445
446
447
448
449
450

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

451
            with utils.timer(
452
                    logger, 'upload deleted from index', step='index',
453
                    upload_size=self.upload_files.size):
454
                search.delete_upload(self.upload_id)
455

456
            with utils.timer(
457
                    logger, 'staged upload deleted', step='files',
458
459
460
461
462
                    upload_size=self.upload_files.size):
                self.upload_files.delete()
                self.delete()

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

464
    @process
465
    def publish_upload(self):
466
467
468
469
470
471
        """
        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.
        """
472
473
        assert self.processed_calcs > 0

474
        logger = self.get_logger()
475
        logger.info('started to publish')
476

477
        with utils.lnr(logger, 'publish failed'):
478
479
            upload_with_metadata = self.to_upload_with_metadata()

480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
            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

495
            with utils.timer(
496
                    logger, 'upload metadata updated', step='metadata',
497
                    upload_size=self.upload_files.size):
498
499

                def create_update(calc):
500
                    calc.published = True
501
502
503
504
505
                    return UpdateOne(
                        {'_id': calc.calc_id},
                        {'$set': {'metadata': calc.to_dict()}})

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

507
508
509
            with utils.timer(
                    logger, 'staged upload files packed', step='pack',
                    upload_size=self.upload_files.size):
510
                self.upload_files.pack(upload_with_metadata)
511
512
513
514

            with utils.timer(
                    logger, 'index updated', step='index',
                    upload_size=self.upload_files.size):
515
                search.publish(calcs)
516
517
518
519
520

            with utils.timer(
                    logger, 'staged upload deleted', step='delete staged',
                    upload_size=self.upload_files.size):
                self.upload_files.delete()
521
522
523
                self.published = True
                self.publish_time = datetime.now()
                self.save()
524

Markus Scheidgen's avatar
Markus Scheidgen committed
525
    @process
526
    def process_upload(self):
Markus Scheidgen's avatar
Markus Scheidgen committed
527
528
529
530
531
532
533
        self.extracting()
        self.parse_all()

    @task
    def uploading(self):
        pass

534
    @property
535
536
537
538
539
    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(
540
                self.upload_id, is_authorized=lambda: True, upload_path=self.upload_path)
541

542
        return self._upload_files
543

544
545
546
547
548
    @property
    def staging_upload_files(self) -> ArchiveBasedStagingUploadFiles:
        assert not self.published
        return cast(ArchiveBasedStagingUploadFiles, self.upload_files)

Markus Scheidgen's avatar
Markus Scheidgen committed
549
550
    @task
    def extracting(self):
551
552
553
554
555
        """
        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.
        """
556
557
558
559
560
        # 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
561
562
        logger = self.get_logger()
        try:
Markus Scheidgen's avatar
Markus Scheidgen committed
563
564
            with utils.timer(
                    logger, 'upload extracted', step='extracting',
565
566
                    upload_size=self.upload_files.size):
                self.upload_files.extract()
567
568
569
570

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

572
        except KeyError:
573
            self.fail('processing requested for non existing upload', log_level=logging.ERROR)
574
575
576
            return
        except ExtractError:
            self.fail('bad .zip/.tar file', log_level=logging.INFO)
Markus Scheidgen's avatar
Markus Scheidgen committed
577
578
            return

579
    def match_mainfiles(self) -> Generator[Tuple[str, object], None, None]:
580
581
582
583
584
585
586
        """
        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
        """
587
        directories_with_match: Dict[str, str] = dict()
588
589
        upload_files = self.staging_upload_files
        for filename in upload_files.raw_file_manifest():
590
            try:
591
                parser = match_parser(filename, upload_files)
592
                if parser is not None:
593
594
                    directory = os.path.dirname(filename)
                    if directory in directories_with_match:
595
596
597
                        # TODO this might give us the chance to store directory based relationship
                        # between calcs for the future?
                        pass
598
599
                    else:
                        directories_with_match[directory] = filename
600
601

                    yield filename, parser
602
603
604
605
            except Exception as e:
                self.get_logger().error(
                    'exception while matching pot. mainfile',
                    mainfile=filename, exc_info=e)
606

Markus Scheidgen's avatar
Markus Scheidgen committed
607
608
    @task
    def parse_all(self):
609
        """
610
        Identified mainfile/parser combinations among the upload's files, creates
611
612
        respective :class:`Calc` instances, and triggers their processing.
        """
613
614
        logger = self.get_logger()

Markus Scheidgen's avatar
Markus Scheidgen committed
615
616
        with utils.timer(
                logger, 'upload extracted', step='matching',
617
618
                upload_size=self.upload_files.size):
            for filename, parser in self.match_mainfiles():
619
                calc = Calc.create(
620
                    calc_id=self.upload_files.calc_id(filename),
621
                    mainfile=filename, parser=parser.name,
622
                    worker_hostname=self.worker_hostname,
623
624
                    upload_id=self.upload_id)

625
                calc.process_calc()
Markus Scheidgen's avatar
Markus Scheidgen committed
626

627
628
629
630
631
632
633
634
635
636
637
638
    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()
639
640
641

    def join(self):
        self.cleanup()
Markus Scheidgen's avatar
Markus Scheidgen committed
642
643
644

    @task
    def cleanup(self):
645
646
        search.refresh()

647
648
649
650
651
652
653
654
        # 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
655
            'You can review your data on your upload page: %s/uploads' % config.api_url()[:-3]
656
        ])
657
658
659
660
661
662
663
        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
664

665
666
667
    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
668
    @property
669
    def processed_calcs(self):
670
        return Calc.objects(upload_id=self.upload_id, tasks_status__in=[SUCCESS, FAILURE]).count()
671
672
673
674
675
676
677

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

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

680
681
    @property
    def pending_calcs(self):
682
        return Calc.objects(upload_id=self.upload_id, tasks_status=PENDING).count()
683

684
685
    def all_calcs(self, start, end, order_by='mainfile'):
        return Calc.objects(upload_id=self.upload_id)[start:end].order_by(order_by)
686
687
688

    @property
    def calcs(self):
Markus Scheidgen's avatar
Markus Scheidgen committed
689
        return Calc.objects(upload_id=self.upload_id, tasks_status=SUCCESS)
Markus Scheidgen's avatar
Markus Scheidgen committed
690
691

    def to_upload_with_metadata(self) -> UploadWithMetadata:
692
693
694
695
        # 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
696
        if self.metadata is not None:
697
698
699
            upload_metadata.update(self.metadata)
            if 'calculations' in upload_metadata:
                del(upload_metadata['calculations'])
Markus Scheidgen's avatar
Markus Scheidgen committed
700

701
702
            for calc in self.metadata.get('calculations', []):
                calc_metadatas[calc['mainfile']] = calc
Markus Scheidgen's avatar
Markus Scheidgen committed
703

704
        user_upload_time = upload_metadata.get('_upload_time', None)
Markus Scheidgen's avatar
Markus Scheidgen committed
705
706
707
708
709
        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)

710
711
712
713
714
        def get_metadata(calc: Calc):
            """
            Assemble metadata from calc's processed calc metadata and the uploads
            user metadata.
            """
715
            calc_data = calc.metadata
716
            calc_with_metadata = CalcWithMetadata(**calc_data)
717
718
            calc_metadata = dict(upload_metadata)
            calc_metadata.update(calc_metadatas.get(calc.mainfile, {}))
719
720
721
722
            calc_with_metadata.apply_user_metadata(calc_metadata)

            return calc_with_metadata

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

Markus Scheidgen's avatar
Markus Scheidgen committed
725
        return result
726
727

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