WIP: feat(vcs): view handlers

* Updated the view handlers and the Jinja templates to accommodate the
new generic structure. The view handlers needed only relatively small
changes, but the Jinja templates had to have all references to 'GitHub',
the GitHub logo, and GitHub URLs replaced with provider-specific
references. The 'vocabulary' defined in the
`RepositoryServiceProviderFactory` specifies the terminology that should
be used for a given VCS, including the name/icon but also the word for
'repository' which is 'project' for GitLab.

* The `ext.py` file is also changed here to reflect the dynamic submenu
entries depending on the VCS providers registered in the config.

* This commit on its own is UNRELEASABLE. We will merge multiple commits
related to the VCS upgrade into the `vcs-staging` branch and then merge
them all into `master` once we have a fully release-ready prototype. At
that point, we will create a squash commit.

Author: palkerecsenyi

invenio_vcs/assets/semantic-ui/js/invenio_vcs/index.js

@@ -0,0 +1,232 @@
+// This file is part of InvenioGithub
+// Copyright (C) 2023 CERN.
+//
+// Invenio Github is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+import $ from "jquery";
+
+function addResultMessage(element, color, icon, message) {
+  element.classList.remove("hidden");
+  element.classList.add(color);
+  element.querySelector(`.icon`).className = `${icon} small icon`;
+  element.querySelector(".content").textContent = message;
+}
+
+// function from https://www.w3schools.com/js/js_cookies.asp
+function getCookie(cname) {
+  let name = cname + "=";
+  let decodedCookie = decodeURIComponent(document.cookie);
+  let ca = decodedCookie.split(";");
+  for (let i = 0; i < ca.length; i++) {
+    let c = ca[i];
+    while (c.charAt(0) == " ") {
+      c = c.substring(1);
+    }
+    if (c.indexOf(name) == 0) {
+      return c.substring(name.length, c.length);
+    }
+  }
+  return "";
+}
+
+const REQUEST_HEADERS = {
+  "Content-Type": "application/json",
+  "X-CSRFToken": getCookie("csrftoken"),
+};
+
+const sync_button = document.getElementById("sync_repos");
+if (sync_button) {
+  sync_button.addEventListener("click", function () {
+    const resultMessage = document.getElementById("sync-result-message");
+    const loaderIcon = document.getElementById("loader_icon");
+    const buttonTextElem = document.getElementById("sync_repos_btn_text");
+    const buttonText = buttonTextElem.innerHTML;
+    const loadingText = sync_button.dataset.loadingText;
+    const provider = sync_button.dataset.provider;
+
+    const url = `/api/user/vcs/${provider}/repositories/sync`;
+    const request = new Request(url, {
+      method: "POST",
+      headers: REQUEST_HEADERS,
+    });
+
+    buttonTextElem.innerHTML = loadingText;
+    loaderIcon.classList.add("loading");
+
+    function fetchWithTimeout(url, options, timeout = 100000) {
+      /** Timeout set to 100000 ms = 1m40s .*/
+      return Promise.race([
+        fetch(url, options),
+        new Promise((_, reject) =>
+          setTimeout(() => reject(new Error('timeout')), timeout)
+        )
+      ]);
+    }
+
+    syncRepos(request);
+
+    async function syncRepos(request) {
+      try {
+        const response = await fetchWithTimeout(request);
+        loaderIcon.classList.remove("loading");
+        sync_button.classList.add("disabled");
+        buttonTextElem.innerHTML = buttonText;
+        if (response.ok) {
+          addResultMessage(
+            resultMessage,
+            "positive",
+            "checkmark",
+            "Repositories synced successfully. Please reload the page."
+          );
+          sync_button.classList.remove("disabled");
+          setTimeout(function () {
+            resultMessage.classList.add("hidden");
+          }, 10000);
+        } else {
+          addResultMessage(
+            resultMessage,
+            "negative",
+            "cancel",
+            `Request failed with status code: ${response.status}`
+          );
+          setTimeout(function () {
+            resultMessage.classList.add("hidden");
+          }, 10000);
+          sync_button.classList.remove("disabled");
+        }
+      } catch (error) {
+        loaderIcon.classList.remove("loading");
+        if(error.message === "timeout"){
+          addResultMessage(
+            resultMessage,
+            "warning",
+            "hourglass",
+            "This action seems to take some time, refresh the page after several minutes to inspect the synchronisation."
+          );
+        }
+        else {
+          addResultMessage(
+            resultMessage,
+            "negative",
+            "cancel",
+            `There has been a problem: ${error}`
+          );
+           setTimeout(function () {
+            resultMessage.classList.add("hidden");
+          }, 7000);
+        }
+      }
+    }
+  });
+}
+
+const repositories = document.getElementsByClassName("repository-item");
+if (repositories) {
+  for (const repo of repositories) {
+    repo.addEventListener("change", function (event) {
+      sendEnableDisableRequest(event.target.checked, repo);
+    });
+  }
+}
+
+function sendEnableDisableRequest(checked, repo) {
+  const input = repo.querySelector("input[data-repo-id]");
+  const repo_id= input.getAttribute("data-repo-id");
+  const provider = input.getAttribute("data-provider");
+  const switchMessage = repo.querySelector(".repo-switch-message");
+
+  let url;
+  if (checked === true) {
+    url = `/api/user/vcs/${provider}/repositories/${repo_id}/enable`;
+  } else if (checked === false) {
+    url = `/api/user/vcs/${provider}/repositories/${repo_id}/disable`;
+  }
+
+  const request = new Request(url, {
+    method: "POST",
+    headers: REQUEST_HEADERS,
+  });
+
+  sendRequest(request);
+
+  async function sendRequest(request) {
+    try {
+      const response = await fetch(request);
+      if (response.ok) {
+        addResultMessage(
+          switchMessage,
+          "positive",
+          "checkmark",
+          "Repository synced successfully. Please reload the page."
+        );
+        setTimeout(function () {
+          switchMessage.classList.add("hidden");
+        }, 10000);
+      } else {
+        addResultMessage(
+          switchMessage,
+          "negative",
+          "cancel",
+          `Request failed with status code: ${response.status}`
+        );
+        setTimeout(function () {
+          switchMessage.classList.add("hidden");
+        }, 5000);
+      }
+    } catch (error) {
+      addResultMessage(
+        switchMessage,
+        "negative",
+        "cancel",
+        `There has been a problem: ${error}`
+      );
+      setTimeout(function () {
+        switchMessage.classList.add("hidden");
+      }, 7000);
+    }
+  }
+}
+
+// DOI badge modal
+$(".doi-badge-modal").modal({
+  selector: {
+    close: ".close.button",
+  },
+  onShow: function () {
+    const modalId = $(this).attr("id");
+    const $modalTrigger = $(`#${modalId}-trigger`);
+    $modalTrigger.attr("aria-expanded", true);
+  },
+  onHide: function () {
+    const modalId = $(this).attr("id");
+    const $modalTrigger = $(`#${modalId}-trigger`);
+    $modalTrigger.attr("aria-expanded", false);
+  },
+});
+
+$(".doi-modal-trigger").on("click", function (event) {
+  const modalId = $(event.target).attr("aria-controls");
+  $(`#${modalId}.doi-badge-modal`).modal("show");
+});
+
+$(".doi-modal-trigger").on("keydown", function (event) {
+  if (event.key === "Enter") {
+    const modalId = $(event.target).attr("aria-controls");
+    $(`#${modalId}.doi-badge-modal`).modal("show");
+  }
+});
+
+// ON OFF toggle a11y
+const $onOffToggle = $(".toggle.on-off");
+
+$onOffToggle &&
+  $onOffToggle.on("change", (event) => {
+    const target = $(event.target);
+    const $onOffToggleCheckedAriaLabel = target.data("checked-aria-label");
+    const $onOffToggleUnCheckedAriaLabel = target.data("unchecked-aria-label");
+    if (event.target.checked) {
+      target.attr("aria-label", $onOffToggleCheckedAriaLabel);
+    } else {
+      target.attr("aria-label", $onOffToggleUnCheckedAriaLabel);
+    }
+  });

invenio_vcs/ext.py

@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2023 CERN.
+# Copyright (C) 2024 Graz University of Technology.
+#
+# Invenio 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.
+#
+# Invenio 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 Invenio; if not, write to the
+# Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+# MA 02111-1307, USA.
+#
+# In applying this license, CERN does not
+# waive the privileges and immunities granted to it by virtue of its status
+# as an Intergovernmental Organization or submit itself to any jurisdiction.
+
+"""Invenio module that adds VCS integration to the platform."""
+
+from flask import current_app, request
+from flask_menu import current_menu
+from invenio_i18n import LazyString
+from invenio_i18n import gettext as _
+from invenio_theme.proxies import current_theme_icons
+from six import string_types
+from werkzeug.utils import cached_property, import_string
+
+from invenio_vcs.config import get_provider_list
+from invenio_vcs.receivers import VCSReceiver
+from invenio_vcs.service import VCSRelease
+from invenio_vcs.utils import obj_or_import_string
+
+from . import config
+
+
+class InvenioVCS(object):
+    """Invenio-VCS extension."""
+
+    def __init__(self, app=None):
+        """Extension initialization."""
+        if app:
+            self.init_app(app)
+
+    @cached_property
+    def release_api_class(self):
+        """Release API class."""
+        cls = current_app.config["VCS_RELEASE_CLASS"]
+        if isinstance(cls, string_types):
+            cls = import_string(cls)
+        assert issubclass(cls, VCSRelease)
+        return cls
+
+    @cached_property
+    def release_error_handlers(self):
+        """Release error handlers."""
+        error_handlers = current_app.config.get("VCS_ERROR_HANDLERS") or []
+        return [
+            (obj_or_import_string(error_cls), obj_or_import_string(handler))
+            for error_cls, handler in error_handlers
+        ]
+
+    def init_app(self, app):
+        """Flask application initialization."""
+        self.init_config(app)
+        app.extensions["invenio-vcs"] = self
+
+    def init_config(self, app):
+        """Initialize configuration."""
+        app.config.setdefault(
+            "VCS_SETTINGS_TEMPLATE",
+            app.config.get("SETTINGS_TEMPLATE", "invenio_vcs/settings/base.html"),
+        )
+
+        for k in dir(config):
+            if k.startswith("VCS_"):
+                app.config.setdefault(k, getattr(config, k))
+
+
+def finalize_app_ui(app):
+    """Finalize app."""
+    if app.config.get("VCS_INTEGRATION_ENABLED", False):
+        init_menu(app)
+        init_webhooks(app)
+
+
+def finalize_app_api(app):
+    """Finalize app."""
+    if app.config.get("VCS_INTEGRATION_ENABLED", False):
+        init_webhooks(app)
+
+
+def init_menu(app):
+    """Init menu."""
+    for provider in get_provider_list(app):
+
+        def is_active(current_node):
+            return (
+                request.endpoint.startswith("invenio_vcs.")
+                and request.view_args.get("provider", "") == current_node.name
+            )
+
+        current_menu.submenu(f"settings.{provider.id}").register(
+            endpoint="invenio_vcs.get_repositories",
+            endpoint_arguments_constructor=lambda id=provider.id: {"provider": id},
+            text=_(
+                "%(icon)s %(provider)s",
+                icon=LazyString(
+                    lambda: f'<i class="{current_theme_icons[provider.icon]}"></i>'
+                ),
+                provider=provider.name,
+            ),
+            order=10,
+            active_when=is_active,
+        )
+
+
+def init_webhooks(app):
+    state = app.extensions.get("invenio-webhooks")
+    if state is not None:
+        for provider in get_provider_list(app):
+            # Procedurally register the webhook receivers instead of including them as an entry point, since
+            # they are defined in the VCS provider config list rather than in the instance's setup.cfg file.
+            if provider.id not in state.receivers:
+                state.register(provider.id, VCSReceiver)