7.6.x -> 8.0.x

arches/app/const.py

@@ -13,3 +13,10 @@ class IntegrityCheck(Enum):
 
     def __str__(self):
         return IntegrityCheckDescriptions[self.value]
+
+
+class ExtensionType(Enum):
+    DATATYPES = "datatypes"
+    ETL_MODULES = "etl_modules"
+    FUNCTIONS = "functions"
+    SEARCH_COMPONENTS = "search_components"

arches/app/datatypes/base.py

@@ -200,7 +200,7 @@ def get_tile_data(self, tile):
                 logger.warning(_("Multiple provisional edits. Returning first edit"))
             userid = list(provisionaledits.keys())[0]
             return provisionaledits[userid]["value"]
-        else:
+        elif not data:
             logger.exception(_("Tile has no authoritative or provisional data"))
 
 

arches/app/datatypes/datatypes.py

@@ -16,6 +16,8 @@
 
 from django.core.files.images import get_image_dimensions
 from django.db.models import fields
+
+from arches.app.const import ExtensionType
 from arches.app.datatypes.base import BaseDataType
 from arches.app.models import models
 from arches.app.models.system_settings import settings
@@ -98,7 +100,7 @@ def get_instance(self, datatype):
         try:
             datatype_instance = DataTypeFactory._datatype_instances[d_datatype.classname]
         except KeyError:
-            class_method = get_class_from_modulename(d_datatype.modulename, d_datatype.classname, settings.DATATYPE_LOCATIONS)
+            class_method = get_class_from_modulename(d_datatype.modulename, d_datatype.classname, ExtensionType.DATATYPES)
             datatype_instance = class_method(d_datatype)
             DataTypeFactory._datatype_instances[d_datatype.classname] = datatype_instance
             self.datatype_instances = DataTypeFactory._datatype_instances

arches/app/datatypes/url.py

@@ -172,7 +172,9 @@ def append_search_filters(self, value, node, query, request):
             pass
 
     def get_rdf_uri(self, node, data, which="r"):
-        return URIRef(data["url"])
+        if data and "url" in data:
+            return URIRef(data["url"])
+        return None
 
     def accepts_rdf_uri(self, uri):
         return self.URL_REGEX.match(uri) and not (

arches/app/media/css/arches.scss

@@ -5571,12 +5571,12 @@ div.card-grid-item.selected {
     width: 100%;
     height: 50px;
     overflow: hidden;
+    display: flex;
 }
 
 .ep-graph-title {
     font-size: 1.6rem;
     padding: 5px;
-    flex-wrap: wrap;
     align-items: center;
 }
 

arches/app/media/js/utils/create-vue-application.js

@@ -10,7 +10,7 @@ import Tooltip from 'primevue/tooltip';
 import { createApp } from 'vue';
 import { createGettext } from "vue3-gettext";
 
-export default async function createVueApp(vueComponent){
+export default async function createVueApplication(vueComponent){
     /**
      * This wrapper allows us to maintain a level of control inside arches-core
      * over Vue apps. For instance this allows us to abstract i18n setup/config

arches/app/media/js/views/plugin-standalone.js

@@ -0,0 +1,15 @@
+import { defineAsyncComponent } from 'vue';
+import createVueApplication from 'utils/create-vue-application';
+
+const pluginData = require('views/plugin-data');
+
+// workaround for webpack failures surrounding dynamic imports
+const vuePluginPath = pluginData['component'].replace('src/', '').replace('.vue', '');
+const AsyncComponent = defineAsyncComponent(() => import(`@/${vuePluginPath}.vue`));
+
+const pluginMountingPoint = document.querySelector('#plugin-mounting-point');
+pluginMountingPoint.setAttribute("id", pluginData['slug']);
+
+createVueApplication(AsyncComponent).then(vueApp => {
+    vueApp.mount(`#${pluginData['slug']}`);
+});

arches/app/media/plugins/revolution-slider/rs-plugin/js/jquery.themepunch.revolution.js

@@ -1703,7 +1703,7 @@
 			container.find('.tp-caption').each(function() { jQuery(this).addClass(jQuery(this).data('transition')); jQuery(this).addClass('start') });
 
 			// PREPARE THE UL CONTAINER TO HAVEING MAX HEIGHT AND HEIGHT FOR ANY SITUATION
-			container.find('>ul:first').css({overflow:'hidden',width:'100%',height:'100%',maxHeight:container.parent().css('maxHeight')}).addClass("tp-revslider-mainul");
+			container.find('>ul:first').css({overflow:'hidden',width:'100%',height:'100%',padding:'0px',maxHeight:container.parent().css('maxHeight')}).addClass("tp-revslider-mainul");
 			if (opt.autoHeight=="on") {
 			   container.find('>ul:first').css({overflow:'hidden',width:'100%',height:'100%',maxHeight:"none"});
 			   container.css({'maxHeight':'none'});

arches/app/models/graph.py

@@ -299,6 +299,7 @@ def add_node(self, node, nodegroups=None):
             node.issearchable = nodeobj.get("issearchable", True)
             node.isrequired = nodeobj.get("isrequired", False)
             node.exportable = nodeobj.get("exportable", False)
+            node.sortorder = nodeobj.get("sortorder", 0)
             node.fieldname = nodeobj.get("fieldname", "")
             node.hascustomalias = nodeobj.get("hascustomalias", False)
             node.sourcebranchpublication_id = nodeobj.get("sourcebranchpublication_id", None)

arches/app/models/models.py

@@ -18,6 +18,7 @@
 import traceback
 import django.utils.timezone
 
+from arches.app.const import ExtensionType
 from arches.app.utils.module_importer import get_class_from_modulename
 from arches.app.utils.thumbnail_factory import ThumbnailGeneratorInstance
 from arches.app.models.fields.i18n import I18n_TextField, I18n_JSONField
@@ -460,7 +461,7 @@ def defaultconfig_json(self):
         return json_string
 
     def get_class_module(self):
-        return get_class_from_modulename(self.modulename, self.classname, settings.FUNCTION_LOCATIONS)
+        return get_class_from_modulename(self.modulename, self.classname, ExtensionType.FUNCTIONS)
 
 
 class FunctionXGraph(models.Model):
@@ -1045,7 +1046,7 @@ class Meta:
         db_table = "search_component"
 
     def get_class_module(self):
-        return get_class_from_modulename(self.modulename, self.classname, settings.SEARCH_COMPONENT_LOCATIONS)
+        return get_class_from_modulename(self.modulename, self.classname, ExtensionType.SEARCH_COMPONENTS)
 
     def toJSON(self):
         from arches.app.utils.betterJSONSerializer import JSONSerializer, JSONDeserializer
@@ -1752,7 +1753,7 @@ class Meta:
         db_table = "etl_modules"
 
     def get_class_module(self):
-        return get_class_from_modulename(self.modulename, self.classname, settings.ETL_MODULE_LOCATIONS)
+        return get_class_from_modulename(self.modulename, self.classname, ExtensionType.ETL_MODULES)
 
 
 class LoadEvent(models.Model):

arches/app/search/components/base.py

@@ -1,3 +1,4 @@
+from arches.app.const import ExtensionType
 from arches.app.models import models
 from arches.app.models.system_settings import settings
 from arches.app.utils.module_importer import get_class_from_modulename
@@ -60,7 +61,7 @@ def get_filter(self, componentname):
             except:
                 filter_instance = None
                 class_method = get_class_from_modulename(
-                    search_filter.modulename, search_filter.classname, settings.SEARCH_COMPONENT_LOCATIONS
+                    search_filter.modulename, search_filter.classname, ExtensionType.SEARCH_COMPONENTS
                 )
                 if class_method:
                     filter_instance = class_method(self.request)

arches/app/tasks.py

@@ -1,3 +1,4 @@
+import importlib
 import os
 import logging
 import shutil
@@ -352,6 +353,53 @@ def bulk_data_deletion(userid, load_id, graph_id, nodegroup_id, resourceids):
         user = User.objects.get(id=userid)
         notify_completion(msg, user)
 
+
+@shared_task
+def run_task(module_name=None, class_name=None, method_to_run=None, **kwargs):
+    """
+        this allows the user to run any method as a celery task
+        module_name, class_name, and method_to_run are required
+        pass any additional arguments to the method via the kwargs parameter
+    """
+
+    theClass = getattr(importlib.import_module(module_name), class_name)
+    theMethod = getattr(theClass(), method_to_run)
+    theMethod(**kwargs)
+
+
+@shared_task
+def run_etl_task(**kwargs):
+    """
+        this allows the user to run the custom etl module
+        import_module, import_class, loadid, userid are the required string parameter
+        importer_name can be added (not required) for messaging purpose
+    """
+
+    logger = logging.getLogger(__name__)
+
+    import_module = kwargs.pop("import_module")
+    import_class = kwargs.pop("import_class")
+    importer_name = kwargs.pop("importer_name", import_class)
+    loadid = kwargs.get("loadid")
+    userid = kwargs.get("userid")
+
+    try:
+        run_task(module_name=import_module, class_name=import_class, method_to_run="run_load_task", **kwargs)
+
+        load_event = models.LoadEvent.objects.get(loadid=loadid)
+        status = _("Completed") if load_event.status == "indexed" else _("Failed")
+    except Exception as e:
+        logger.error(e)
+        load_event = models.LoadEvent.objects.get(loadid=loadid)
+        load_event.status = "failed"
+        load_event.save()
+        status = _("Failed")
+    finally:
+        msg = _("{}: {}").format(importer_name, status)
+        user = User.objects.get(id=userid)
+        notify_completion(msg, user)
+
+
 @shared_task
 def reverse_etl_load(loadid):
     from arches.app.etl_modules import base_import_module

arches/app/templates/base-manager.htm

@@ -239,7 +239,7 @@ <h1 class="brand-text" style="margin-top: 15px;">{{ app_name }}</h1>
 
                             {% for p in plugins %}
                                 {% if p.config is not None %}
-                                    {% if p.config.show is not False %}
+                                    {% if p.config.show and not p.config.is_standalone %}
                                     <!-- ko let: {uid: Math.random().toString()} -->
                                     <li {% if main_script == "views/plugin" and plugin.pluginid == p.pluginid %} class="active-sub" {% endif %}>
                                         {% if p.slug is not None %}

arches/app/templates/views/plugin-standalone.htm

@@ -0,0 +1,86 @@
+<!--
+ARCHES - a program developed to inventory and manage immovable cultural heritage.
+Copyright (C) 2013 J. Paul Getty Trust and World Monuments Fund
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+-->
+{% load static %}
+{% load webpack_static from webpack_loader %}
+
+
+<!DOCTYPE html>
+<!--[if IE 8]> <html lang="en" class="ie8"> <![endif]-->
+<!--[if IE 9]> <html lang="en" class="ie9"> <![endif]-->
+<!--[if !IE]><!--> <html lang="en"> <!--<![endif]-->
+
+<head>
+    <title>
+        {% block title %} {{ plugin.name }} {% endblock title %}
+    </title>
+
+        <!-- Meta -->
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <meta name="description" content="">
+        <meta name="author" content="">
+
+        <link rel="shortcut icon" href="{% webpack_static 'favicons/favicon.ico' %}" type="image/x-icon" />
+        <link rel="apple-touch-icon" href="{% webpack_static 'favicons/apple-touch-icon.png' %}" />
+        <link rel="apple-touch-icon" sizes="76x76" href="{% webpack_static 'favicons/apple-touch-icon-76x76.png' %}" />
+        <link rel="apple-touch-icon" sizes="120x120" href="{% webpack_static 'favicons/apple-touch-icon-120x120.png' %}" />
+        <link rel="apple-touch-icon" sizes="152x152" href="{% webpack_static 'favicons/apple-touch-icon-152x152.png' %}" />
+        <link rel="apple-touch-icon" sizes="180x180" href="{% webpack_static 'favicons/apple-touch-icon-180x180.png' %}" />
+
+        {% block css %}
+            <!-- POC rough out of PrimeVue theme switcher -->
+            <link rel="stylesheet" href="{% webpack_static 'node_modules/primevue/resources/themes/mdc-light-indigo/theme.css' %}" />
+            <link rel="stylesheet" href="{% webpack_static 'node_modules/font-awesome/css/font-awesome.min.css' %}" />
+        {% endblock css %}
+</head>
+
+<body>
+    {% block main_content %}
+        <div id="plugin-mounting-point"></div>
+    {% endblock main_content %}
+</body>
+
+{% block javascript %}
+    <script src="{% webpack_static 'node_modules/requirejs/require.js' %}"></script>
+
+    {% block pre_require_js %}
+        <div
+            id="pluginData"
+            style="display: none;"
+            pluginData='{{ plugin_json }}'
+        ></div>
+    {% endblock pre_require_js %}
+
+    {% if main_script %}
+        <script src="{% webpack_static '' %}build/js/{{main_script}}.js"></script>
+    {% endif %}
+
+    {% if app_settings.GOOGLE_ANALYTICS_TRACKING_ID != None %}
+        <script>
+            (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+                (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+                m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+            })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+            ga('create', '{{app_settings.GOOGLE_ANALYTICS_TRACKING_ID}}', 'auto');
+            ga('send', 'pageview');
+        </script>
+    {% endif %}
+{% endblock javascript %}
+
+</html>

arches/app/utils/decorators.py

@@ -59,7 +59,7 @@ def new_func(*args, **kwargs):
     return new_func
 
 
-def group_required(*group_names):
+def group_required(*group_names, raise_exception=False):
     """
     Requires user membership in at least one of the groups passed in.
 
@@ -69,6 +69,9 @@ def in_groups(u):
         if u.is_authenticated:
             if u.is_superuser or bool(u.groups.filter(name__in=group_names)):
                 return True
+        if raise_exception:
+            raise PermissionDenied
+        # else: user_passes_test() redirects to nowhere
         return False
 
     return user_passes_test(in_groups)

arches/app/utils/module_importer.py

@@ -1,17 +1,39 @@
 import importlib
 
+from arches.app.const import ExtensionType
+from arches.app.models.system_settings import settings
+
 
 def get_module(path, modulename=""):
     module = importlib.machinery.SourceFileLoader(modulename, path).load_module()
     return module
 
 
-def get_class_from_modulename(modulename, classname, directory_list):
+def get_directories(extension_type: ExtensionType):
+    core_root_dir = f"arches.app.{extension_type.value}"
+    if extension_type is ExtensionType.SEARCH_COMPONENTS:
+        core_root_dir = core_root_dir.replace("search_components", "search.components")
+
+    core_and_arches_app_dirs = [core_root_dir]
+    for arches_app in settings.ARCHES_APPLICATIONS:
+        core_and_arches_app_dirs.append(f"{arches_app}.{extension_type.value}")
+        core_and_arches_app_dirs.append(f"{arches_app}.pkg.extensions.{extension_type.value}")
+
+    filtered_settings_dirs = [
+        setting_dir for setting_dir in
+        getattr(settings, extension_type.value.upper()[:-1] + "_LOCATIONS")
+        if setting_dir not in core_and_arches_app_dirs
+    ]
+
+    return core_and_arches_app_dirs + filtered_settings_dirs
+
+
+def get_class_from_modulename(modulename, classname, extension_type: ExtensionType):
     mod_path = modulename.replace(".py", "")
     module = None
     import_success = False
     import_error = None
-    for directory in directory_list:
+    for directory in get_directories(extension_type):
         try:
             module = importlib.import_module(directory + ".%s" % mod_path)
             import_success = True

arches/app/views/api.py

@@ -15,7 +15,6 @@
 from rdflib.namespace import SKOS, DCTERMS
 from revproxy.views import ProxyView
 from slugify import slugify
-from operator import attrgetter
 from urllib import parse
 from collections import OrderedDict
 from django.contrib.auth import authenticate
@@ -1155,7 +1154,10 @@ def get(self, request, resourceid):
 
             cardwidgets = [
                 widget
-                for widgets in [sorted(card.cardxnodexwidget_set.all(), key=attrgetter("sortorder")) for card in permitted_cards]
+                for widgets in [
+                    sorted(card.cardxnodexwidget_set.all(), key=lambda x: x.sortorder or 0)
+                    for card in permitted_cards
+                ]
                 for widget in widgets
             ]