Merge pull request #467 from Espurna/task/424-dashboard-all-mine

xispa · web-flow · commit 39ff71b1c2ab · 2017-12-16T22:47:03.000+01:00
Dashboard all/mine filters
diff --git a/bika/lims/browser/dashboard/dashboard.py b/bika/lims/browser/dashboard/dashboard.py
@@ -3,41 +3,103 @@
 # Copyright 2011-2016 by it's authors.
 # Some rights reserved. See LICENSE.txt, AUTHORS.txt.
 
+import datetime
+import json
+from calendar import monthrange
+
+from DateTime import DateTime
+from Products.Archetypes.public import DisplayList
 from Products.CMFCore.utils import getToolByName
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
+
+from bika.lims import bikaMessageFactory as _
+from bika.lims import logger
 from bika.lims.browser import BrowserView
-from bika.lims.catalog import CATALOG_ANALYSIS_REQUEST_LISTING
 from bika.lims.catalog import CATALOG_ANALYSIS_LISTING
+from bika.lims.catalog import CATALOG_ANALYSIS_REQUEST_LISTING
 from bika.lims.catalog import CATALOG_WORKSHEET_LISTING
-from bika.lims import bikaMessageFactory as _
-from bika.lims import logger
-from calendar import monthrange
-from DateTime import DateTime
-import plone
-import json
-import datetime
+from bika.lims.utils import get_strings
+
+DASHBOARD_FILTER_COOKIE = 'dashboard_filter_cookie'
 
 
 class DashboardView(BrowserView):
     template = ViewPageTemplateFile("templates/dashboard.pt")
 
+    def __init__(self, context, request):
+        BrowserView.__init__(self, context, request)
+        self.dashboard_cookie = None
+        self.member = None
+
     def __call__(self):
         tofrontpage = True
         mtool=getToolByName(self.context, 'portal_membership')
         if not mtool.isAnonymousUser() and self.context.bika_setup.getDashboardByDefault():
             # If authenticated user with labman role,
             # display the Main Dashboard view
             pm = getToolByName(self.context, "portal_membership")
-            member = pm.getAuthenticatedMember()
-            roles = member.getRoles()
+            self.member = pm.getAuthenticatedMember()
+            roles = self.member.getRoles()
             tofrontpage = 'Manager' not in roles and 'LabManager' not in roles
 
-        if tofrontpage == True:
+        if tofrontpage:
             self.request.response.redirect(self.portal_url + "/bika-frontpage")
         else:
             self._init_date_range()
+            self.dashboard_cookie = self.check_dashboard_cookie()
             return self.template()
 
+    def check_dashboard_cookie(self):
+        """
+        Check if the dashboard cookie should exist through bikasetup
+        configuration.
+
+        If it should exist but doesn't exist yet, the function creates it
+        with all values as default.
+        If it should exist and already exists, it returns the value.
+        Otherwise, the function returns None.
+
+        :return: a dictionary of strings
+        """
+        # Getting cookie
+        cookie_raw = self.request.get(DASHBOARD_FILTER_COOKIE, None)
+        # If it doesn't exist, create it with default values
+        if cookie_raw is None:
+            cookie_raw = self._create_raw_data()
+            self.request.response.setCookie(
+                DASHBOARD_FILTER_COOKIE,
+                json.dumps(cookie_raw),
+                quoted=False,
+                path='/')
+            return cookie_raw
+        return get_strings(json.loads(cookie_raw))
+
+    def is_filter_selected(self, selection_id, value):
+        """
+        Compares whether the 'selection_id' parameter value saved in the
+        cookie is the same value as the "value" parameter.
+
+        :param selection_id: a string as a dashboard_cookie key.
+        :param value: The value to compare against the value from
+        dashboard_cookie key.
+        :return: Boolean.
+        """
+        selected = self.dashboard_cookie.get(selection_id)
+        return selected == value
+
+    def _create_raw_data(self):
+        """
+        Gathers the different sections ids and creates a string as first
+        cookie data.
+
+        :return: A dictionary like:
+            {'analyses':'all','analysisrequest':'all','worksheets':'all'}
+        """
+        result = {}
+        for section in self.get_sections():
+            result[section.get('id')] = 'all'
+        return result
+
     def _init_date_range(self):
         """ Sets the date range from which the data must be retrieved.
             Sets the values to the class parameters 'date_from',
@@ -130,6 +192,17 @@ def get_sections(self):
                     self.get_worksheets_section()]
         return sections
 
+    def get_filter_options(self):
+        """
+        Returns dasboard filter options.
+        :return: Boolean
+        """
+        dash_opt = DisplayList((
+            ('all', _('All')),
+            ('mine', _('Mine')),
+        ))
+        return dash_opt
+
     def _getStatistics(self, name, description, url, catalog, criterias, total):
         out = {'type':        'simple-panel',
                'name':        name,
@@ -163,6 +236,10 @@ def get_analysisrequests_section(self):
             cookie_dep_uid = self.request.get('filter_by_department_info', '').split(',') if filtering_allowed else ''
             query['getDepartmentUIDs'] = { "query": cookie_dep_uid,"operator":"or" }
 
+        # Check if dashboard_cookie contains any values to query
+        # elements by
+        query = self._update_criteria_with_filters(query, 'analysisrequests')
+
         # Active Analysis Requests (All)
         total = len(catalog(query))
 
@@ -256,6 +333,10 @@ def get_worksheets_section(self):
             cookie_dep_uid = self.request.get('filter_by_department_info', '').split(',') if filtering_allowed else ''
             query['getDepartmentUIDs'] = { "query": cookie_dep_uid,"operator":"or" }
 
+        # Check if dashboard_cookie contains any values to query
+        # elements by
+        query = self._update_criteria_with_filters(query, 'worksheets')
+
         # Active Worksheets (all)
         total = len(bc(query))
 
@@ -316,6 +397,9 @@ def get_analyses_section(self):
             cookie_dep_uid = self.request.get('filter_by_department_info', '').split(',') if filtering_allowed else ''
             query['getDepartmentUID'] = { "query": cookie_dep_uid,"operator":"or" }
 
+        # Check if dashboard_cookie contains any values to query elements by
+        query = self._update_criteria_with_filters(query, 'analyses')
+
         # Active Analyses (All)
         total = len(bc(query))
 
@@ -522,3 +606,19 @@ def _fill_dates_evo(self, catalog, query):
                     del o[r]
 
         return outevo
+
+    def _update_criteria_with_filters(self, query, section_name):
+        """
+        This method updates the 'query' dictionary with the criteria stored in
+        dashboard cookie.
+
+        :param query: A dictionary with search criteria.
+        :param section_name: The dashboard section name
+        :return: The 'query' dictionary
+        """
+        if self.dashboard_cookie is None:
+            return query
+        cookie_criteria = self.dashboard_cookie.get(section_name)
+        if cookie_criteria == 'mine':
+            query['Creator'] = self.member.getId()
+        return query
diff --git a/bika/lims/browser/dashboard/readme.txt b/bika/lims/browser/dashboard/readme.txt
@@ -0,0 +1,15 @@
+"All" and "Mine" selection functionality:
+=========================================
+
+A selection list with the values 'All' and 'Mine' will be added above each
+section of the Dashboard. The panels and information within each panel will
+change according to the option selected: for example, if the user selects
+'Mine', the panel with the summary of worksheets and worksheets statuses will
+only take into account the worksheets to which the user is assigned.
+
+Panels visibility
+=================
+
+The labmanager will be able to configure the visibility of each panel on a
+user-role basis directly from the dashboard (configuration option
+embedded in each panel).
diff --git a/bika/lims/browser/dashboard/templates/dashboard.pt b/bika/lims/browser/dashboard/templates/dashboard.pt
@@ -25,13 +25,33 @@
     .dashboard-section {
         padding: 20px 0 0;
     }
-
-    .dashboard-section h2 {
+    .dashboard-section-head {
         background-color: #ccc;
         border-radius: 5px 5px 0 0;
+        padding: 3px 15px;
+    }
+    .dashboard-section-head div.actions {
+        float:right;
+        text-align:right;
+        width:30%;
+    }
+    .dashboard-section-head div.actions select {
+        padding: 0 5px;
+        vertical-align: top;
+    }
+    .dashboard-section-head:after {
+        clear: both;
+        content: " ";
+        display: block;
+        font-size: 0;
+        height: 0;
+        visibility: hidden;
+    }
+    .dashboard-section h2 {
+        float:left;
         font-size: 1.4em;
         font-weight: bold;
-        padding: 3px 15px;
+        width:70%;
     }
     .dashboard-section .h2-legend {
         font-size: 0.9em;
@@ -194,6 +214,7 @@
     $(document).ready(function(){
         loadPieCharts();
         loadBarCharts();
+        dashboard_cookie_controller();
     });
 
     function loadBarCharts() {
@@ -389,12 +410,67 @@
                 .attr("d", arc);
         });
       }
+      function dashboard_cookie_controller() {
+        /* Links a linker controller to each dashboard filter selector.
+        This controller reads the cookie data once the selector has been
+        modified and updates its data.
+        */
+        var selector;
+        var selector_section_id;
+        var cookie;
+        var counter;
+        var cookie_id = 'dashboard_filter_cookie'
+        var filter_selectors = $('select.dashboard_filters');
+        for(counter = 0; counter < filter_selectors.length; counter++){
+          selector = filter_selectors[counter];
+          $(selector).live('change', function(){
+            section_id = $(this).attr('section_id');
+            selected = $(this).find(':selected').val();
+            cookie_data = render_cookie_data(readCookie(cookie_id));
+            cookie_data[section_id] = selected;
+            cookie_data = build_cookie_data(cookie_data);
+            setCookie('dashboard_filter_cookie', cookie_data);
+            window.location.reload(true);
+          });
+        }
+      };
+      /*TODO: I can't call the function defined in bika.lims.site.setCookie*/
+      function setCookie(cname, cvalue) {
+        var d = new Date();
+        d.setTime(d.getTime() + (1 * 24 * 60 * 60 * 1000));
+        var expires = "expires="+d.toUTCString();
+        document.cookie = cname + "=" + cvalue + ";" + expires + ";path=/";
+      };
+      function render_cookie_data(data){
+        return JSON.parse(data);
+      };
+      function build_cookie_data(data){
+        return JSON.stringify(data);
+      };
     }(jQuery));
 </script>
 
 <tal:section repeat="section python:view.get_sections()">
 <div class='dashboard-section'>
-    <h2 tal:content="section/title" class='dashboard-section-title'></h2>
+    <div class='dashboard-section-head'>
+        <h2 tal:content="section/title" class='dashboard-section-title'></h2>
+        <div class="actions">
+            <select class="dashboard_filters"
+                tal:attributes="section_id section/id"
+                tal:define="section_id section/id">
+                <tal:dashboard_filter_opts
+                    define="options python: view.get_filter_options()"
+                    repeat="option options">
+                    <option
+                        tal:attributes="
+                            value python:option;
+                            selected python: 'selected' if view.is_filter_selected(section_id, option) else '';"
+                        tal:content="python:options.getValue(option)">
+                    </option>
+                </tal:dashboard_filter_opts>
+            </select>
+        </div>
+    </div>
     <div class='dashboard-panels'>
 
         <!-- Bar-chart panels -->
diff --git a/bika/lims/utils/__init__.py b/bika/lims/utils/__init__.py
@@ -774,3 +774,34 @@ def to_int(value, default=0):
         return int(value)
     except (TypeError, ValueError):
         return to_int(default, default=0)
+
+
+def get_strings(data):
+    """
+    Convert unicode values to strings even if they belong to lists or dicts.
+    :param data: an object.
+    :return: The object with all unicode values converted to string.
+    """
+    # if this is a unicode string, return its string representation
+    if isinstance(data, unicode):
+        return data.encode('utf-8')
+
+    # if this is a list of values, return list of string values
+    if isinstance(data, list):
+        return [get_strings(item) for item in data]
+
+    # if this is a dictionary, return dictionary of string keys and values
+    if isinstance(data, dict):
+        return {
+            get_strings(key): get_strings(value)
+            for key, value in data.iteritems()
+        }
+    # if it's anything else, return it in its original form
+    return data
+
+
+def is_bika_installed():
+    """Check if Bika LIMS is installed in the Portal
+    """
+    qi = api.portal.get_tool("portal_quickinstaller")
+    return qi.isProductInstalled("bika.lims")
