Team enhancements v3

docker-compose.yml

@@ -19,6 +19,8 @@ x-ifcb-common: &ifcb-common
 services:
   ifcbdb:
     <<: *ifcb-common
+    env_file:
+      - .env
     environment:
       - NGINX_HOST=${HOST:-localhost}
       - NGINX_HTTP_PORT=${HTTP_PORT:-80}

dotenv.template

@@ -20,3 +20,4 @@ DJANGO_SECRET_KEY=changeme
 POSTGRES_PASSWORD=changeme
 
 #LOCAL_SETTINGS=./local_settings.py
+

ifcbdb/assets/css/site.css

@@ -248,6 +248,20 @@ table .btn-mdb-color {
     text-overflow: ellipsis;
 }
 
+#team-nav-menu {
+    -webkit-columns: 3;
+    -moz-columns: 3;
+    columns: 3;
+    list-style-position: inside;
+    overflow-x: auto;
+}
+
+#team-nav-menu li a{
+    overflow: hidden;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+}
+
 #filter-content {
     min-width: 250px;
 }
@@ -384,7 +398,7 @@ a.tstabcollapser:after
 #go-to-bid-pid {
     height:22px;
     margin-top:9px;
-    width:200px;
+    width:100px;
     border:none;
     padding-left:2px;
     padding-right:2px;

ifcbdb/assets/js/bin.js

@@ -40,33 +40,38 @@ var _autoCompleteJS;
 
 //************* Common Methods ***********************/
 
+function getPage(page, queryString = "") {
+    return window.location.pathname.replace(/[^/]+$/, page)
+        + (queryString ? "?" + queryString : "");
+}
+
 // Generates a relative link to the current bin/dataset
 function createLink() {
     // Bin Mode
     if (_route != "timeline")
         return createBinModeLink();
 
     // Timeline Mode
-    return "/timeline?" +
-        buildFilterOptionsQueryString(true) +
-        (_bin != "" ? "&bin=" + _bin : "");
+    const queryString = buildFilterOptionsQueryString(true) + (_bin != "" ? "&bin=" + _bin : "");
+
+    return getPage("timeline", queryString);
 }
 
 function createListLink(start, end) {
     if (!isFilteringUsed())
         return "javascript:;;";
 
-    return "/list?" + getGroupingParameters(_bin) +
-        "&start_date=" + start +
-        "&end_date=" + end;
+    const queryString = getGroupingParameters(_bin) + "&start_date=" + start + "&end_date=" + end;
+
+    return getPage("list", queryString);
 }
 
 function createBinModeLink(bin) {
     if (bin == "" || typeof bin == "undefined") {
         bin = _bin;
     }
 
-    return "/bin?" + getGroupingParameters(bin);
+    return getPage("bin", getGroupingParameters(bin));
 }
 
 function getGroupingParameters(bin) {
@@ -104,15 +109,15 @@ function createBinLink(bin) {
         return createBinModeLink(bin);
     }
 
-    return "/timeline?" + getGroupingParameters(bin);
+    return getPage("timeline", getGroupingParameters(bin));
 }
 
 function createImageLink(imageId) {
     if (_route == "bin") {
-        return "/image?image=" + imageId + "&bin=" + _bin;
+        return getPage("image", "image=" + imageId + "&bin=" + _bin);
     }
 
-    var url = "/image?image=" + imageId;
+    var url = getPage("image", "image=" + imageId);
     var parameters = getGroupingParameters(_bin);
 
     return url + (parameters != "" ? "&" + parameters : "");
@@ -171,7 +176,7 @@ function updateBinStats(data) {
     }
 
     $("#stat-instrument").html(data["instrument"]);
-    $("#stat-instrument-link").attr('href','/timeline?instrument='+data["instrument"]+'&bin='+_bin);
+    $("#stat-instrument-link").attr('href', getPage("timeline", 'instrument='+data["instrument"]+'&bin='+_bin));
     $("#stat-num-triggers").html(data["num_triggers"]);
     $("#stat-num-images").html(data["num_images"]);
     $("#stat-trigger-freq").html(data["trigger_freq"]);
@@ -226,12 +231,11 @@ function updateBinDatasets(data) {
     $("#dataset-links").empty();
 
     for (var i = 0; i < data.datasets.length; i++) {
-        // <a href="#" class="d-block">asdasd</a>
         $("#dataset-links").append(
             $("<a class='d-block' />")
-            .attr("href", "/timeline?bin=" + _bin + "&dataset=" + data.datasets[i])
+            .attr("href", getPage("timeline", "bin=" + _bin + "&dataset=" + data.datasets[i]))
             .text(data.datasets[i])
-        )
+        );
     }
 }
 
@@ -367,8 +371,10 @@ function displayTags(tags) {
     for (var i = 0; i < tags.length; i++) {
         var tag = tags[i];
         var li = $("<span class='badge badge-pill badge-light mx-1'>");
-        var link = "timeline?tags=" + tag + "&" +
-            buildFilterOptionsQueryString(false, _dataset, _instrument, null, _cruise, _sampleType);
+
+        const queryString = "tags=" + tag + "&" + buildFilterOptionsQueryString(
+            false, _dataset, _instrument, null, _cruise, _sampleType);
+        var link = getPage("timeline", queryString);
 
         var span = li.html("<a href='"+link+"'>"+tag+"</a>");
         var icon = $("<i class='fas fa-times pl-1'></i>");
@@ -1029,12 +1035,11 @@ function initEvents() {
     $("#share-button").click(function(e) {
         e.preventDefault();
 
-        var link = $("#share-link");
-        var base = link.data("scheme") + "://" + link.data("host");
+        const rootUrl = window.location.protocol + "//" + window.location.host;
 
         $("#share-modal").modal();
         $("#share-modal .modal-title").text($("#share-modal .modal-title").data("default-text"));
-        $("#share-link").val(base + createLink()).select();
+        $("#share-link").val(rootUrl + createLink()).select();
     });
 
     // Copy the share link to the clipboard

ifcbdb/assets/js/site.js

@@ -14,6 +14,11 @@ const MAX_SELECTABLE_IMAGES = 25;
 
 let _binFilterMode = "timeline";
 
+function getPage(page, queryString) {
+    return window.location.pathname.replace(/[^/]+$/, page)
+        + (queryString ? "?" + queryString : "");
+}
+
 function initDashboard(appSettings) {
     defaultLat = appSettings.default_latitude;
     defaultLng = appSettings.default_longitude;
@@ -36,7 +41,7 @@ function initDashboard(appSettings) {
     });
 
     $("#dataset-switcher").change(function () {
-        location.href = "/timeline?dataset=" + $(this).val();
+        location.href = getPage("timeline") + "dataset=" + $(this).val();
     });
 
     $("#go-to-bin").click(function () {
@@ -511,7 +516,7 @@ function goToBin(pid) {
             return;
         }
 
-        location.href = "/bin?bin=" + pid.trim();
+        location.href = getPage("bin", "bin=" + pid.trim());
     });
 }
 
@@ -579,13 +584,41 @@ function isFilteringUsed() {
         return true;
 }
 
+// Formats a list of Django validation errors into an <ul />
+function formatValidationErrorsAsList(errors) {
+    const items = [];
+
+    for (const [field, messages] of Object.entries(errors)) {
+
+        // Capitalize and format field name (e.g., "email_address" -> "Email Address")
+        const fieldName = field.replace(/_/g, ' ').replace(/\b\w/g, c => c.toUpperCase());
+
+        messages.forEach(message => {
+            const prefix = field === "__all__" ? "" : `<strong>${fieldName}:</strong> `;
+
+            items.push(`<li>${prefix}${message}</li>`);
+        });
+    }
+
+    return "<ul class='error-list mb-0'>" + items.join() + "</ul>";
+}
+
 $(function () {
-    $('#dataset-popover').popover({
+    $('#datasets-popover').popover({
         container: 'body',
-        title: 'Select Dataset',
+        title: 'Dataset',
         html: true,
         placement: 'bottom',
         sanitize: false,
         template:  '<div class="popover" style="max-width:60%;" role="tooltip"><div class="arrow"></div><h3 class="popover-header"></h3><div class="popover-body" style="max-height:50vh; overflow-y:auto;"></div></div>'
-    })
+    });
+
+    $('#teams-popover').popover({
+        container: 'body',
+        title: 'Teams',
+        html: true,
+        placement: 'bottom',
+        sanitize: false,
+        template:  '<div class="popover" style="max-width:60%;" role="tooltip"><div class="arrow"></div><h3 class="popover-header"></h3><div class="popover-body" style="max-height:50vh; overflow-y:auto;"></div></div>'
+    });
   })

ifcbdb/common/auth.py

@@ -0,0 +1,112 @@
+from django.contrib.auth.models import User, Group
+from dashboard.models import Dataset, Team, TeamDataset, TeamUser
+from .constants import TeamRoles
+
+# At the moment, this is simply a wrapper around the superadmin flag. In the future, this, and possibly other
+#   methods, will be used to determine access rules based on which teams a user is associated with and what
+#   their assigned role is for that team
+def is_admin(user):
+    if not user.is_authenticated:
+        return False
+
+    return user.is_superuser
+
+# This one is also just a wrapper around the staff flag. This is likely what will be used to determine if a user
+#   has access to things "quickly" without having to check through associated teams and roles on those records
+def is_staff(user):
+    if not user.is_authenticated:
+        return False
+
+    if not user.is_staff:
+        return False
+
+    return user.is_staff
+
+def can_manage_teams(user):
+    if not user.is_authenticated:
+        return False
+
+    if user.is_superuser or user.is_staff:
+        return True
+
+    # Team captains have limited access to the admin to manage their own teams
+    return has_team_roles(user, [TeamRoles.CAPTAIN, ])
+
+def can_manage_datasets(user):
+    if not user.is_authenticated:
+        return False
+
+    if user.is_superuser or user.is_staff:
+        return True
+
+    # Team captains have limited access to the admin to manage their own teams
+    return has_team_roles(user, [TeamRoles.CAPTAIN, ])
+
+def can_manage_metadata(user):
+    if not user.is_authenticated:
+        return False
+
+    if user.is_superuser or user.is_staff:
+        return True
+
+    # Team captains have limited access to the admin to manage their own teams
+    return has_team_roles(user, [TeamRoles.CAPTAIN, ])
+
+def can_manage_bins(user):
+    if not user.is_authenticated:
+        return False
+
+    if user.is_superuser or user.is_staff:
+        return True
+
+    # Team captains have limited access to the admin to manage their own teams
+    return has_team_roles(user, [TeamRoles.CAPTAIN, ])
+
+def can_access_settings(user):
+    if not user.is_authenticated:
+        return False
+
+    if user.is_superuser or user.is_staff:
+        return True
+
+    return has_team_roles(user, [TeamRoles.CAPTAIN, ])
+
+def has_team_roles(user, roles):
+    role_values = [role.value for role in roles]
+
+    return TeamUser.objects \
+        .filter(user=user) \
+        .filter(role_id__in=role_values) \
+        .exists()
+
+def get_manageable_teams(user):
+    if not user.is_authenticated:
+        return []
+
+    if user.is_superuser or user.is_staff:
+        return Team.objects.all()
+
+    return Team.objects \
+        .filter(teamuser__user=user) \
+        .filter(teamuser__role_id__in=[TeamRoles.CAPTAIN.value, ]) \
+        .distinct()
+
+def get_manageable_datasets(user, exclude_inactive=True):
+    if not user.is_authenticated:
+        return []
+
+    datasets = Dataset.objects.all()
+
+    if exclude_inactive:
+        datasets = datasets.exclude(is_active=False)
+
+    if user.is_superuser or user.is_staff:
+        return datasets
+
+    teams = get_manageable_teams(user)
+
+    dataset_ids = TeamDataset.objects \
+        .filter(team__in=teams) \
+        .values_list("dataset_id", flat=True)
+
+    return datasets.filter(id__in=dataset_ids)

ifcbdb/common/constants.py

@@ -0,0 +1,20 @@
+from enum import Enum
+
+class TeamRoles(Enum):
+    CAPTAIN = 1
+    MANAGER = 2
+    USER = 3
+
+# Values for this enum should map to their environment variable names
+class Features(Enum):
+    TEAMS = "Teams"
+
+
+class BinManagementActions(Enum):
+    SKIP_BINS = "skip-bins"
+    UNSKIP_BINS = "unskip-bins"
+    ASSIGN_DATASET = "assign-dataset"
+    UNASSIGN_DATASET = "unassign-dataset"
+
+# Metadata column names
+BIN_ID_COLUMNS = ['id','pid','lid','bin','bin_id','sample','sample_id','filename']