#
# This file is part of HEPData.
# Copyright (C) 2016 CERN.
#
# HEPData is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of the
# License, or (at your option) any later version.
#
# HEPData is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with HEPData; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
#
from flask import Blueprint, render_template, request, jsonify, abort
from flask_login import login_required, current_user
from invenio_db import db
from hepdata.ext.opensearch.admin_view.api import AdminIndexer
from hepdata.modules.email.api import send_cookie_email, notify_submission_created
from hepdata.modules.inspire_api.views import get_inspire_record_information
from hepdata.modules.permissions.models import SubmissionParticipant
from hepdata.modules.records.utils.submission import \
get_or_create_hepsubmission
from hepdata.modules.records.utils.workflow import create_record
from hepdata.utils.users import user_is_admin_or_coordinator
blueprint = Blueprint(
'submission',
__name__,
url_prefix='/submit',
template_folder='templates',
static_folder='static'
)
[docs]
@blueprint.route('', methods=['GET'])
@login_required
def submit_ui():
if user_is_admin_or_coordinator(current_user):
return render_template('hepdata_submission/submit.html')
else:
abort(403)
[docs]
@blueprint.route('', methods=['POST'])
@login_required
def submit_post():
inspire_id = request.form['inspire_id']
title = request.form['title']
reviewer_str = request.form['reviewer']
uploader_str = request.form['uploader']
message = request.form['message']
reviewer = parse_person_string(reviewer_str)[0]
uploader = parse_person_string(uploader_str)[0]
hepdata_submission = process_submission_payload(inspire_id=inspire_id,
title=title,
reviewer=reviewer,
uploader=uploader, message=message)
if hepdata_submission:
return jsonify({'success': True, 'message': 'Submission successful.'})
else:
return jsonify({'success': False, 'message': 'Submission unsuccessful.'})
[docs]
def process_submission_payload(*args, **kwargs):
"""
Processes the submission payload.
:param inspire_id:
:param title:
:param reviewer:
:param uploader:
:param send_upload_email:
:return:
"""
if kwargs.get('inspire_id'):
content, status = get_inspire_record_information(kwargs.get('inspire_id'))
content["inspire_id"] = kwargs.get('inspire_id')
elif kwargs.get('title'):
content = {'title': kwargs.get('title')}
else:
raise ValueError(message="A title or inspire_id must be provided.")
record_information = create_record(content)
submitter_id = kwargs.get('submitter_id')
if submitter_id is None:
submitter_id = kwargs.get('user_id') if 'user_id' in kwargs else int(current_user.get_id())
hepsubmission = get_or_create_hepsubmission(record_information["recid"], submitter_id)
if kwargs.get('inspire_id'):
hepsubmission.inspire_id = kwargs.get('inspire_id')
db.session.add(hepsubmission)
reviewer_details = kwargs.get('reviewer')
reviewer = create_participant_record(
reviewer_details.get('name'),
reviewer_details.get('email'), 'reviewer', 'primary',
record_information['recid'])
db.session.add(reviewer)
uploader_details = kwargs.get('uploader')
uploader = create_participant_record(uploader_details.get('name'), uploader_details.get('email'),
'uploader', 'primary',
record_information['recid'])
db.session.add(uploader)
db.session.commit()
if kwargs.get('send_upload_email', True):
# Now Send Email only to the uploader first. The reviewer will be asked to
# review only when an upload has been performed.
message = kwargs.get('message', None)
send_cookie_email(uploader, record_information, message)
notify_submission_created(record_information, submitter_id, uploader, reviewer)
admin_idx = AdminIndexer()
admin_idx.index_submission(hepsubmission)
return hepsubmission
[docs]
def create_participant_record(name, email, role, status, recid):
participant_record = SubmissionParticipant(full_name=name,
email=email,
status=status,
role=role,
publication_recid=recid)
return participant_record
[docs]
def parse_person_string(person_string, separator="::"):
"""
Parses a string in the format name::email into separate parts.
:param person_string: e.g. John::j.p.a@cern.ch
:param separator: by default '::'
:return: name, email
"""
if separator in person_string:
string_parts = person_string.split(separator)
return {'name': string_parts[0], 'email': string_parts[1]},
return {'name': person_string, 'email': person_string}
