wip: orcha

Author: OliverGeneser

invenio_app_rdm/config.py

@@ -1626,3 +1626,5 @@ def github_link_render(record):
 
 MULTIPROFILER_PERMISSION = administration_permission.can
 """Function to check for permissions to access the profiler."""
+
+RDM_DEPOSIT_ORCHA_ENABLED = False

invenio_app_rdm/records_ui/views/deposits.py

@@ -399,6 +399,9 @@ def get_form_config(**kwargs):
     if record_quota:
         quota["maxStorage"] = record_quota["quota_size"]
         quota["quotaIncrease"] = evaluate_quota_increase(record, identity)
+    orcha_enabled = conf.get("RDM_DEPOSIT_ORCHA_ENABLED", False)
+    if callable(orcha_enabled):
+        orcha_enabled = orcha_enabled()
 
     return dict(
         vocabularies=VocabulariesOptions().dump(),
@@ -423,6 +426,7 @@ def get_form_config(**kwargs):
         default_transfer_type=current_transfer_registry.default_transfer_type,
         enabled_transfer_types=list(current_transfer_registry.get_transfer_types()),
         transfer_types=file_transfer_type()["transfer_types"],
+        orcha_enabled=orcha_enabled,
         **kwargs,
     )
 

invenio_app_rdm/theme/assets/semantic-ui/js/invenio_app_rdm/deposit/RDMDepositForm.js

@@ -0,0 +1,87 @@
+import React from "react";
+import PropTypes from "prop-types";
+import { connect } from "react-redux";
+import { Button, Message } from "semantic-ui-react";
+import { useSuggestions } from "./Context";
+import { i18next } from "@translations/invenio_app_rdm/i18next";
+
+const getDraftId = (record) => {
+  const id = record?.id;
+  return id && id !== "null" && id !== "undefined" ? id : null;
+};
+
+export const SuggestionsButtonComponent = ({ record, currentRecord, file }) => {
+  const suggestions = useSuggestions();
+
+  if (!suggestions) return null;
+
+  const {
+    isLoading,
+    status,
+    error,
+    activeFileKey,
+    suggestionsCount,
+    trigger,
+    dismissError,
+  } = suggestions;
+  const draftRecord = getDraftId(currentRecord) ? currentRecord : record;
+  const draftId = getDraftId(draftRecord);
+  const fileKey = file?.name ?? null;
+  const isCurrentFile = !fileKey || activeFileKey === fileKey;
+  const isButtonLoading = isLoading && isCurrentFile;
+  const showError = error && isCurrentFile;
+  const showSuggestionsCount = status === "success" && isCurrentFile;
+  let label = i18next.t("Extract metadata");
+  if (isButtonLoading) {
+    label = i18next.t("Extracting metadata...");
+  } else if (status === "success" && isCurrentFile) {
+    label = i18next.t("Re-extract metadata");
+  }
+
+  return (
+    <div className="orcha-suggestions-button">
+      <Button
+        type="button"
+        primary
+        compact
+        size="mini"
+        loading={isButtonLoading}
+        disabled={isLoading || !draftId || !fileKey}
+        icon="magic"
+        content={label}
+        onClick={() => trigger(draftRecord, fileKey)}
+      />
+      {showSuggestionsCount && (
+        <span className="orcha-suggestions-count ml-5">
+          {i18next.t("Extracted {{count}} suggestions", {
+            count: suggestionsCount,
+          })}
+        </span>
+      )}
+      {showError && (
+        <Message negative size="mini" className="mt-5" onDismiss={dismissError}>
+          {error}
+        </Message>
+      )}
+    </div>
+  );
+};
+
+SuggestionsButtonComponent.propTypes = {
+  record: PropTypes.object.isRequired,
+  currentRecord: PropTypes.object,
+  file: PropTypes.shape({
+    name: PropTypes.string,
+  }),
+};
+
+SuggestionsButtonComponent.defaultProps = {
+  currentRecord: null,
+  file: null,
+};
+
+const mapStateToProps = (state) => ({
+  currentRecord: state.deposit?.record,
+});
+
+export const SuggestionsButton = connect(mapStateToProps)(SuggestionsButtonComponent);

invenio_app_rdm/theme/assets/semantic-ui/js/invenio_app_rdm/deposit/orcha/Button.js

@@ -0,0 +1,10 @@
+import { createContext, useContext } from "react";
+
+const SuggestionsContext = createContext(null);
+
+export const useSuggestions = () => {
+  return useContext(SuggestionsContext);
+};
+
+export default SuggestionsContext;
+export { SuggestionsContext };

invenio_app_rdm/theme/assets/semantic-ui/js/invenio_app_rdm/deposit/orcha/Context.js

@@ -0,0 +1,137 @@
+import React from "react";
+import PropTypes from "prop-types";
+import { connect as connectFormik } from "formik";
+import { Button, Icon, Message } from "semantic-ui-react";
+import { useSuggestions } from "./Context";
+import { i18next } from "@translations/invenio_app_rdm/i18next";
+import { makeIcon } from "../../utils";
+
+// This is the mapping for suggestion feild translation
+const suggestedFieldLabels = {
+  doi: "DOI",
+  title: "Title",
+  publication_date: "Publication date",
+  creators: "Authors/Creators",
+  description: "Description",
+};
+
+const renderAuthor = (author) => (
+  <>
+    {author.orcid && <span>{makeIcon("orcid", author.orcid, author.name)} </span>}
+    <strong> {author.name}</strong>
+    {author.affiliation && <span> {author.affiliation}</span>}
+  </>
+);
+
+const renderSuggestionActions = (onApply, onDeny) => (
+  <Button.Group size="mini" className="orcha-suggestion-actions">
+    <Button
+      type="button"
+      positive
+      icon="check"
+      content={i18next.t("Apply")}
+      onClick={onApply}
+    />
+    <Button
+      type="button"
+      negative
+      icon="times"
+      aria-label={i18next.t("Deny")}
+      onClick={onDeny}
+    />
+  </Button.Group>
+);
+
+const renderSuggestedCreators = (value, onApply, onDeny) => {
+  return (
+    <ul className="orcha-suggestion-list">
+      {value.map((author, index) => (
+        <li key={author.orcid ?? `${index}-${author.name}`}>
+          <span className="orcha-suggestion-value">{renderAuthor(author)}</span>
+          {renderSuggestionActions(
+            () => onApply(index),
+            () => onDeny(index)
+          )}
+        </li>
+      ))}
+    </ul>
+  );
+};
+
+const renderSuggestedValue = (field, value) => {
+  if (field === "creators" && Array.isArray(value)) {
+    return (
+      <ul className="orcha-suggestion-list">
+        {value.map((author, index) => (
+          <li key={author.orcid ?? `${index}-${author.name}`}>
+            {renderAuthor(author)}
+          </li>
+        ))}
+      </ul>
+    );
+  }
+  return <span>{value}</span>;
+};
+
+const FieldSuggestionComponent = ({ field, formik }) => {
+  const suggestions = useSuggestions();
+
+  if (!suggestions) return null;
+  if (!formik) return null;
+
+  const { getSuggestion, apply, deny } = suggestions;
+  const suggestion = getSuggestion(field);
+
+  if (!suggestion) return null;
+
+  const isCreatorsSuggestion = field === "creators" && Array.isArray(suggestion.value);
+
+  if (suggestion.status === "applied") {
+    return null;
+  }
+
+  if (suggestion.status === "denied") {
+    return null;
+  }
+
+  return (
+    <Message size="tiny" info className="orcha-field-suggestion">
+      <Message.Content>
+        <Message.Header>
+          <Icon name="lightbulb outline" />
+          {i18next.t("Suggested {{field}}", {
+            field: i18next.t(suggestedFieldLabels[field] ?? "Value"),
+          })}
+        </Message.Header>
+        {isCreatorsSuggestion ? (
+          renderSuggestedCreators(
+            suggestion.value,
+            (index) => apply(formik, field, index),
+            (index) => deny(field, index)
+          )
+        ) : (
+          <div className="orcha-suggestion-row">
+            <div className="orcha-suggestion-value">
+              {renderSuggestedValue(field, suggestion.value)}
+            </div>
+            {renderSuggestionActions(
+              () => apply(formik, field),
+              () => deny(field)
+            )}
+          </div>
+        )}
+      </Message.Content>
+    </Message>
+  );
+};
+
+FieldSuggestionComponent.propTypes = {
+  field: PropTypes.string.isRequired,
+  formik: PropTypes.object,
+};
+
+FieldSuggestionComponent.defaultProps = {
+  formik: null,
+};
+
+export const FieldSuggestion = connectFormik(FieldSuggestionComponent);