Allow admin to set DataBrowser default report

Author: bbimber

laboratory/api-src/org/labkey/api/laboratory/TabbedReportItem.java

@@ -46,7 +46,6 @@ public class TabbedReportItem extends AbstractNavItem
     private final Map<String, FieldKey> _additionalKeys = new HashMap<>();
 
     public static final String OVERRIDES_PROP_KEY = "laboratory.tabItemOverride";
-    public static final String FILTER_PROP_KEY = "laboratory.tabItemFilterOverride";
 
     protected static final Logger _log = LogManager.getLogger(TabbedReportItem.class);
 
@@ -177,6 +176,23 @@ public static String getOverridesPropertyKey(NavItem item)
         return item.getDataProvider().getKey() + "||tabReport||" + item.getReportCategory() + "||" + item.getName() + "||" + item.getLabel();
     }
 
+    public boolean hasOverride(Container c, String propName)
+    {
+        Map<String, String> map = PropertyManager.getProperties(c, OVERRIDES_PROP_KEY);
+        if (!map.containsKey(getPropertyManagerKey()))
+        {
+            return false;
+        }
+
+        JSONObject props = new JSONObject(map.get(getPropertyManagerKey()));
+        if (!props.has(propName))
+        {
+            return false;
+        }
+
+        return true;
+    }
+
     public static void applyOverrides(NavItem item, Container c, JSONObject json)
     {
         Map<String, String> map = PropertyManager.getProperties(c, OVERRIDES_PROP_KEY);
@@ -188,9 +204,9 @@ public static void applyOverrides(NavItem item, Container c, JSONObject json)
 
             if (props.has("reportCategory"))
                 json.put("reportCategory", props.get("reportCategory"));
-            // retained for settings saved prior to refactor
-            else if (props.has("category"))
-                json.put("reportCategory", props.get("category"));
+
+            if (props.has("isDefaultReport"))
+                json.put("isDefaultReport", props.get("isDefaultReport"));
         }
     }
 }

laboratory/resources/web/laboratory/panel/CustomizeDataBrowserPanel.js

@@ -69,6 +69,9 @@ Ext4.define('Laboratory.panel.CustomizeDataBrowserPanel', {
         },{
             html: '<b>Visible?</b>',
             style: 'padding-bottom: 5px;margin-left: 5px;'
+        },{
+            html: '<b>Default Report?</b>',
+            style: 'padding-bottom: 5px;margin-left: 5px;'
         }];
 
         items = LDK.Utils.sortByProperty(items, 'name', false);
@@ -90,17 +93,22 @@ Ext4.define('Laboratory.panel.CustomizeDataBrowserPanel', {
                 width: 300,
                 value: item.label
             },{
-                xtype: 'displayfield',
-                value: item.visible,
+                xtype: 'checkbox',
+                checked: item.visible,
                 style: 'margin-left: 15px;'
+            },{
+                xtype: 'radio',
+                name: 'isDefaultReport',
+                inputValue: true,
+                checked: item.isDefaultReport
             }]);
         }, this);
 
         var cfg = {
             itemId: 'theTable',
             layout: {
                 type: 'table',
-                columns: 4
+                columns: 5
             },
             border: false,
             defaults: {
@@ -117,15 +125,17 @@ Ext4.define('Laboratory.panel.CustomizeDataBrowserPanel', {
     doSave: function(btn){
         var toSave = {};
         var items = btn.up('form').down('#theTable').items;
-        var cols = 4;
+        var cols = 5;
         var rows = (items.getCount() / cols);
 
         for (var i=1;i<rows;i++){
             var base = i * cols;
             var navItem = items.get(base).navItem;
             toSave[navItem.overridesKey] = {
+                reportCategory: items.get(base + 1).getValue(),
                 label:  items.get(base + 2).getValue(),
-                reportCategory: items.get(base + 1).getValue()
+                isVisible: items.get(base + 3).getValue(),
+                isDefaultReport: items.get(base + 4).getValue()
             }
         }
 

laboratory/resources/web/laboratory/panel/DataBrowserPanel.js

@@ -5,7 +5,6 @@ Ext4.define('Laboratory.panel.DataBrowserPanel', {
         Ext4.ns('Laboratory.tabbedReports');
 
         Ext4.apply(this, {
-            //defaultReport: 'abstract',
             reportNamespace: Laboratory.tabbedReports
         });
 
@@ -23,6 +22,7 @@ Ext4.define('Laboratory.panel.DataBrowserPanel', {
     onDataLoad: function(results){
         Ext4.Msg.hide();
         this.reports = [];
+        var foundDefault = false;
         Ext4.each(results.tabbedReports, function(report){
             LDK.Assert.assertNotEmpty('Tabbed Report is null', report);
             if (report && report.key){
@@ -33,6 +33,16 @@ Ext4.define('Laboratory.panel.DataBrowserPanel', {
                     report.containerPath = report.targetContainer;
                 }
                 this.reports.push(report);
+
+                if (report.isDefaultReport) {
+                    this.defaultReport = report.id;
+                    if (foundDefault) {
+                        log.error('More than one TabbedReport marked as default!');
+                    }
+
+                    foundDefault = true;
+                    console.log(this.defaultReport);
+                }
             }
         }, this);
 

laboratory/src/org/labkey/laboratory/LaboratoryController.java

@@ -1658,6 +1658,8 @@ public ApiResponse execute(JsonDataForm form, BindException errors)
             Map<String, Object> results = new HashMap<>();
 
             WritablePropertyMap propMap = PropertyManager.getWritableProperties(getContainer(), TabbedReportItem.OVERRIDES_PROP_KEY, true);
+            WritablePropertyMap visibilityMap = PropertyManager.getWritableProperties(getContainer(), NavItem.PROPERTY_CATEGORY, true);
+            boolean shouldSaveVisibility = false;
 
             List<TabbedReportItem> tabbedReports = LaboratoryService.get().getTabbedReportItems(getContainer(), getUser());
             Map<String, TabbedReportItem> reportMap = new HashMap<String, TabbedReportItem>();
@@ -1669,7 +1671,7 @@ public ApiResponse execute(JsonDataForm form, BindException errors)
             JSONObject json = new JSONObject(form.getJsonData());
             for (String key : json.keySet())
             {
-                JSONObject toSave= new JSONObject();
+                JSONObject toSave = new JSONObject();
 
                 TabbedReportItem ti = reportMap.get(key);
                 if (ti == null)
@@ -1685,13 +1687,49 @@ public ApiResponse execute(JsonDataForm form, BindException errors)
                 if (reportCategory != null && !ti.getReportCategory().equals(reportCategory))
                     toSave.put("reportCategory", reportCategory);
 
-                if (toSave.keySet().size() > 0)
+                String isDefaultReport = StringUtils.trimToNull(props.optString("isDefaultReport"));
+                if (isDefaultReport != null)
+                {
+                    if (!ti.hasOverride(getContainer(), "isDefaultReport"))
+                    {
+                        if ("true".equals(isDefaultReport))
+                        {
+                            toSave.put("isDefaultReport", isDefaultReport);
+                        }
+                    }
+                    else
+                    {
+                        toSave.put("isDefaultReport", isDefaultReport);
+                    }
+                }
+
+                String isVisible = StringUtils.trimToNull(props.optString("isVisible"));
+                if (isVisible != null)
+                {
+                    if (!isVisible.equals(visibilityMap.get(ti.getPropertyManagerKey())))
+                    {
+                        visibilityMap.put(ti.getPropertyManagerKey(), isVisible);
+                        shouldSaveVisibility = true;
+                    }
+                }
+
+                if (!toSave.isEmpty())
+                {
                     propMap.put(key, toSave.toString());
-                else propMap.remove(key);
+                }
+                else
+                {
+                    propMap.remove(key);
+                }
             }
 
             propMap.save();
 
+            if (shouldSaveVisibility)
+            {
+                visibilityMap.save();
+            }
+
             results.put("success", true);
             return new ApiSimpleResponse(results);
         }