Frontend Status Badges

ckanext/xloader/config_declaration.yaml

@@ -153,5 +153,21 @@ groups:
           that is not in ckanext.xloader.formats after a Resource is updated.
         type: bool
         required: false
+      - key: ckanext.xloader.show_badges
+        default: True
+        example: False
+        description: |
+          Controls whether or not the status badges display in the front end.
+        type: bool
+        required: false
+      - key: ckanext.xloader.debug_badges
+        default: False
+        example: True
+        description: |
+          Controls whether or not the status badges display all of the statuses. By default,
+          the badges will display "pending", "running", and "error". With debug_badges enabled,
+          they will also display "complete", "active", "inactive", and "unknown".
+        type: bool
+        required: false
 
 

ckanext/xloader/helpers.py

@@ -1,5 +1,7 @@
 import ckan.plugins.toolkit as toolkit
 from ckanext.xloader.utils import XLoaderFormats
+from markupsafe import Markup
+from html import escape as html_escape
 
 
 def xloader_status(resource_id):
@@ -42,3 +44,82 @@ def is_resource_supported_by_xloader(res_dict, check_access=True):
     else:
         is_supported_url_type = True
     return (is_supported_format or is_datastore_active) and user_has_access and is_supported_url_type
+
+
+def xloader_badge(resource):
+    # type: (dict) -> str
+    """
+    Displays a custom badge for the status of Xloader and DataStore for the specified resource.
+    """
+    if not toolkit.asbool(toolkit.config.get('ckanext.xloader.show_badges', True)):
+        return ''
+
+    if not XLoaderFormats.is_it_an_xloader_format(resource.get('format')):
+        # we only want to show badges for supported xloader formats
+        return ''
+
+    is_datastore_active = resource.get('datastore_active', False)
+
+    try:
+        xloader_job = toolkit.get_action("xloader_status")({'ignore_auth': True},
+                                                           {"resource_id": resource.get('id')})
+    except toolkit.ObjectNotFound:
+        xloader_job = {}
+
+    if xloader_job.get('status') == 'complete':
+        # the xloader task is complete, show datastore active or inactive.
+        # xloader will delete the datastore table at the beggining of the job run.
+        # so this will only be true if the job is fully finished.
+        status = 'active' if is_datastore_active else 'inactive'
+    elif xloader_job.get('status') in ['submitting', 'pending', 'running', 'running_but_viewable', 'error']:
+        # the job is running or pending or errored
+        # show the xloader status
+        status = xloader_job.get('status')
+        if status == 'running_but_viewable':
+            # treat running_but_viewable the same as running
+            status = 'running'
+        elif status == 'submitting':
+            # treat submitting the same as pending
+            status = 'pending'
+    else:
+        # we do not know what the status is
+        status = 'unknown'
+
+    messages = {
+        # Default messages
+        'pending': toolkit._('Data awaiting load to DataStore'),
+        'running': toolkit._('Loading data into DataStore'),
+        'error': toolkit._('Failed to load data into DataStore'),
+        # Debug messages
+        'complete': toolkit._('Data loaded into DataStore'),
+        'active': toolkit._('Data available in DataStore'),
+        'inactive': toolkit._('Resource not active in DataStore'),
+        'unknown': toolkit._('DataStore status unknown'),
+    }
+    basic_statuses = ['pending', 'running', 'error']
+
+    if status not in basic_statuses and not toolkit.asbool(toolkit.config.get('ckanext.xloader.debug_badges', False)):
+        return ''
+
+    badge_url = toolkit.h.url_for_static('/static/badges/{lang}/datastore-{status}.svg'.format(
+        lang=toolkit.h.lang(), status=status))
+
+    title = toolkit.h.render_datetime(xloader_job.get('last_updated'), with_hours=True) \
+        if xloader_job.get('last_updated') else ''
+
+    try:
+        toolkit.check_access('resource_update', {'user': toolkit.g.user}, {'id': resource.get('id')})
+        pusher_url = toolkit.h.url_for('xloader.resource_data',
+                                       id=resource.get('package_id'),
+                                       resource_id=resource.get('id'))
+
+        return Markup(u'<a href="{pusher_url}" class="loader-badge"><img src="{badge_url}" alt="{alt}" title="{title}"/></a>'.format(
+            pusher_url=pusher_url,
+            badge_url=badge_url,
+            alt=html_escape(messages[status], quote=True),
+            title=html_escape(title, quote=True)))
+    except toolkit.NotAuthorized:
+        return Markup(u'<span class="loader-badge"><img src="{badge_url}" alt="{alt}" title="{title}"/></span>'.format(
+            badge_url=badge_url,
+            alt=html_escape(messages[status], quote=True),
+            title=html_escape(title, quote=True)))

ckanext/xloader/plugin.py

@@ -58,6 +58,7 @@ def get_blueprint(self):
 
     def update_config(self, config):
         toolkit.add_template_directory(config, 'templates')
+        toolkit.add_public_directory(config, 'public')
 
     # IConfigurable
 
@@ -242,6 +243,7 @@ def get_helpers(self):
             "xloader_status": xloader_helpers.xloader_status,
             "xloader_status_description": xloader_helpers.xloader_status_description,
             "is_resource_supported_by_xloader": xloader_helpers.is_resource_supported_by_xloader,
+            "xloader_badge": xloader_helpers.xloader_badge,
         }