views.py

# -*- coding: utf-8 -*-
import re
import os
import flask_mongorest

from itertools import permutations
from css_html_js_minify import html_minify
from json2html import Json2Html
from boltons.iterutils import remap
from werkzeug.exceptions import Unauthorized
from pymatgen.core.composition import Composition, CompositionError

from flask import Blueprint, render_template, jsonify, abort, request
from flask_mongorest.resources import Resource
from flask_mongorest import operators as ops
from flask_mongorest.methods import (
    Fetch,
    Delete,
    Update,
    BulkFetch,
    BulkCreate,
    BulkUpdate,
    BulkDelete,
    Download,
)
from flask_mongorest.exceptions import UnknownFieldError

from mpcontribs.api import enter, FILTERS
from mpcontribs.api.core import SwaggerView
from mpcontribs.api.contributions.document import Contributions
from mpcontribs.api.structures.views import StructuresResource
from mpcontribs.api.tables.views import TablesResource
from mpcontribs.api.attachments.views import AttachmentsResource
from mpcontribs.api.notebooks.views import NotebooksResource

templates = os.path.join(os.path.dirname(flask_mongorest.__file__), "templates")
contributions = Blueprint("contributions", __name__, template_folder=templates)
exclude = r'[^$.\s_~`^&(){}[\]\\;\'"/]'
j2h = Json2Html()
MAX_UNAPPROVED_CONTRIBS = 500


def visit(path, key, value):
    if isinstance(value, dict) and "display" in value:
        return key, value["display"]
    return True


class ContributionsResource(Resource):
    document = Contributions
    related_resources = {
        "structures": StructuresResource,
        "tables": TablesResource,
        "attachments": AttachmentsResource,
        "notebook": NotebooksResource,
    }
    save_related_fields = ["structures", "tables", "attachments", "notebook"]
    filters = {
        "id": [ops.In, ops.Exact],
        "project": FILTERS["STRINGS"],
        "identifier": FILTERS["STRINGS"],
        "formula": FILTERS["STRINGS"],
        "is_public": [ops.Boolean],
        "last_modified": FILTERS["DATES"],
        "needs_build": [ops.Boolean],
        re.compile(r"^data__((?!__).)*$"): FILTERS["ALL"],
        "structures": [ops.Size],
        "tables": [ops.Size],
        "attachments": [ops.Size],
    }
    fields = [
        "id",
        "project",
        "identifier",
        "formula",
        "is_public",
        "last_modified",
        "needs_build",
    ]
    allowed_ordering = [
        "id",
        "project",
        "identifier",
        "formula",
        "is_public",
        "last_modified",
        "needs_build",
        re.compile(r"^data(__(" + exclude + ")+){1,4}$"),
    ]
    paginate = True
    default_limit = 200
    max_limit = 1500
    download_formats = ["json", "csv"]

    @staticmethod
    def get_optional_fields():
        return [
            "data",
            "structures",
            "tables",
            "attachments",
            "notebook",
            "card_bootstrap",
            "card_bulma",
        ]

    def value_for_field(self, obj, field):
        if field.startswith("card_"):
            _, fmt = field.rsplit("_", 1)
            if fmt not in ["bootstrap", "bulma"]:
                raise UnknownFieldError

            if obj.project is None or not obj.data:
                # try data reload to account for custom queryset manager
                obj.reload("id", "project", "data")

            # obj.project is LazyReference & Projects uses custom queryset manager
            DocType = obj.project.document_type
            exclude = list(DocType._fields.keys())
            only = ["title", "references", "description", "authors"]
            pk = obj.project.pk
            project = DocType.objects.exclude(*exclude).only(*only).with_id(pk)
            ctx = {
                "cid": str(obj.id),
                "title": project.title,
                "references": project.references[:5],
                "landing_page": f"/projects/{project.id}/",
                "more": f"/contributions/{obj.id}",
            }
            ctx["descriptions"] = project.description.strip().split(".", 1)
            authors = [a.strip() for a in project.authors.split(",") if a]
            ctx["authors"] = {"main": authors[0], "etal": authors[1:]}
            ctx["data"] = j2h.convert(
                json=remap(obj.data, visit=visit, enter=enter),
                table_attributes='class="table is-narrow is-fullwidth has-background-light"',
            )
            return html_minify(render_template(f"card_{fmt}.html", **ctx))
        else:
            raise UnknownFieldError


class ContributionsView(SwaggerView):
    resource = ContributionsResource
    methods = [
        Fetch,
        Delete,
        Update,
        BulkFetch,
        BulkCreate,
        BulkUpdate,
        BulkDelete,
        Download,
    ]

    def has_add_permission(self, req, obj):
        # limit the number of contributions for unapproved projects
        if not self.is_admin_or_project_user(req, obj):
            return False

        if not obj.project.is_approved:
            nr_contribs = Contributions.objects(project=obj.project.id).count()
            if nr_contribs > MAX_UNAPPROVED_CONTRIBS:
                msg = f"Reached {MAX_UNAPPROVED_CONTRIBS} for unapproved project {obj.project.id}."
                msg += " Please reach out to contribs@materialsproject.org."
                raise Unauthorized(f"Can't add {obj.identifier}: {msg}")

        query = dict(project=obj.project.id, identifier=obj.identifier)
        if obj.project.unique_identifiers and Contributions.objects(**query).count():
            raise Unauthorized(f"{obj.identifier} already added for {obj.project.id}")

        return True