Web interface for product listing

- The CodeChecker Viewer now by default opens a product list. Users can select the product they want to view and will be routed to the run list. - If only ONE products exist on the server, simply opening http://host:port will automatically redirect the user to the run list of this single product. - This will only happen if this only product is properly connected. - Added a button to run lists to explicitly return to the product list page - The current product's name is now shown in the run list's title bar [ci skip]
Ericsson · Aug 23, 2017 · afde871 · afde871
1 parent 28b3e78
commit afde871
Show file tree

Hide file tree

Showing 15 changed files with 635 additions and 60 deletions.
diff --git a/api/README.md b/api/README.md
@@ -9,3 +9,8 @@ See [report_server.thrift](https://raw.githubusercontent.com/Ericsson/codechecke
 ## Authentication system API
 The authentication layer is used for supporting privileged-access only access.
 See [authentication.thrift](https://raw.githubusercontent.com/Ericsson/codechecker/master/thrift_api/authentication.thrift)
+
+## Product management system API
+The product management layer is responsible for handling requests about the
+different products and their configuration. See
+[products.thrift](https://raw.githubusercontent.com/Ericsson/codechecker/master/thrift_api/products.thrift)
diff --git a/api/products.thrift b/api/products.thrift
@@ -50,10 +50,25 @@ typedef list<Product> Products
 
 service codeCheckerProductService {
 
-  // *** Handling the add-modify-remove of products registered *** //
-  Products getProducts()
+  // Return the product management API version.
+  string getAPIVersion(),
+
+  // Returns the CodeChecker version that is running on the server.
+  string getPackageVersion(),
+
+  // *** Handling of product lists and metadata querying *** //
+
+  // Get the list of product that matches the display name and endpoint
+  // filters specified.
+  Products getProducts(1: string productEndpointFilter,
+                       2: string productNameFilter)
                        throws (1: shared.RequestFailed requestError),
 
+  Product getCurrentProduct()
+                            throws (1: shared.RequestFailed requestError),
+
+  // *** Handling the add-modify-remove of products registered *** //
+
   bool addProduct(1: Product product)
                   throws (1: shared.RequestFailed requestError),
 

diff --git a/docs/images/products.png b/docs/images/products.png
diff --git a/libcodechecker/server/client_db_access_handler.py b/libcodechecker/server/client_db_access_handler.py
@@ -38,7 +38,7 @@
 
 from run_db_model import *
 
-LOG = LoggerFactory.get_new_logger('ACCESS HANDLER')
+LOG = LoggerFactory.get_new_logger('RUN ACCESS HANDLER')
 
 
 def conv(text):

diff --git a/libcodechecker/server/client_db_access_server.py b/libcodechecker/server/client_db_access_server.py
@@ -45,13 +45,23 @@
 
 LOG = LoggerFactory.get_new_logger('DB ACCESS')
 
-NON_PRODUCT_NAMES = ['index.html',
+# A list of top-level path elements under the webserver root
+# which should not be considered as a product route.
+NON_PRODUCT_NAMES = ['products.html',
+                     'index.html',
                      'fonts',
                      'images',
                      'scripts',
                      'style'
                      ]
 
+# A list of top-level path elements in requests (such as Thrift endpoints)
+# which should not be considered as a product route.
+NON_PRODUCT_NAMES += ['Authentication',
+                      'Products',
+                      'CodeCheckerService'
+                      ]
+
 
 class RequestHandler(SimpleHTTPRequestHandler):
     """
@@ -60,9 +70,6 @@ class RequestHandler(SimpleHTTPRequestHandler):
     """
 
     def __init__(self, request, client_address, server):
-        self.db_version_info = server.db_version_info
-        self.manager = server.manager
-
         BaseHTTPRequestHandler.__init__(self,
                                         request,
                                         client_address,
@@ -80,7 +87,7 @@ def __check_auth_in_request(self):
         present.
         """
 
-        if not self.manager.isEnabled():
+        if not self.server.manager.isEnabled():
             return None
 
         success = None
@@ -98,9 +105,10 @@ def __check_auth_in_request(self):
                 values = cookie.split("=")
                 if len(values) == 2 and \
                         values[0] == session_manager.SESSION_COOKIE_NAME:
-                    if self.manager.is_valid(values[1], True):
+                    if self.server.manager.is_valid(values[1], True):
                         # The session cookie contains valid data.
-                        success = self.manager.get_session(values[1], True)
+                        success = self.server.manager.get_session(values[1],
+                                                                  True)
 
         if success is None:
             # Session cookie was invalid (or not found...)
@@ -114,7 +122,8 @@ def __check_auth_in_request(self):
                     self.headers.getheader("Authorization").
                     replace("Basic ", ""))
 
-                session = self.manager.create_or_get_session(authString)
+                session = self.server.manager.create_or_get_session(
+                    authString)
                 if session:
                     LOG.info("Client from " + client_host + ":" +
                              str(client_port) +
@@ -144,7 +153,8 @@ def __get_product_name(self):
         # viewer client from the www/ folder.
 
         # The split array looks like ['', 'product-name', ...].
-        return urlparse.urlparse(self.path).path.split('/', 2)[1]
+        first_part = urlparse.urlparse(self.path).path.split('/', 2)[1]
+        return first_part if first_part not in NON_PRODUCT_NAMES else None
 
     def do_GET(self):
         """
@@ -167,12 +177,12 @@ def do_GET(self):
             self.send_header("Content-length", str(len(error_body)))
             self.send_header('Connection', 'close')
             self.end_headers()
-            self.wfile.write(self.manager.getRealm()["error"])
+            self.wfile.write(error_body)
             return
         else:
             product_name = self.__get_product_name()
 
-            if product_name not in NON_PRODUCT_NAMES and product_name != '':
+            if product_name is not None and product_name != '':
                 if not self.server.get_product(product_name):
                     LOG.info("Product named '{0}' does not exist."
                              .format(product_name))
@@ -189,13 +199,14 @@ def do_GET(self):
                     LOG.debug("Redirecting user from /{0} to /{0}/index.html"
                               .format(product_name))
 
-                    # WARN: Browsers cache '301 Moved Permanently' responses,
+                    # WARN: Browsers cache '308 Permanent Redirect' responses,
                     # in the event of debugging this, use Private Browsing!
-                    self.send_response(301)
+                    self.send_response(308)
                     self.send_header("Location",
                                      self.path.replace(product_name,
                                                        product_name + '/', 1))
                     self.end_headers()
+                    return
                 else:
                     # Serves the main page and the resources:
                     # /prod/(index.html) -> /(index.html)
@@ -205,24 +216,35 @@ def do_GET(self):
                         "{0}/".format(product_name), "", 1)
                     LOG.debug("Product routing after: " + self.path)
             else:
-                self.send_response(200)  # 200 OK
-                if auth_session is not None:
-                    # Browsers get a standard cookie for session.
-                    self.send_header(
-                        "Set-Cookie",
-                        "{0}={1}; Path=/".format(
-                            session_manager.SESSION_COOKIE_NAME,
-                            auth_session.auth_token))
+                if self.path in ['/', '/index.html']:
+                    only_product = self.server.get_only_product()
+                    if only_product and only_product.connected:
+                        LOG.debug("Redirecting '/' to ONLY product '/{0}'"
+                                  .format(only_product.endpoint))
+
+                        self.send_response(307)  # 307 Temporary Redirect
+                        self.send_header("Location",
+                                         '/{0}'.format(only_product.endpoint))
+                        self.end_headers()
+                        return
 
-                if self.path in ['/', '/index.html', '/products.html']:
                     # Route homepage queries to serving the product list.
                     LOG.debug("Serving product list as homepage.")
-                    self.path = "/products.html"
+                    self.path = '/products.html'
                 else:
                     # The path requested does not specify a product: it is most
                     # likely a resource file.
                     LOG.debug("Serving resource '{0}'".format(self.path))
 
+                self.send_response(200)  # 200 OK
+                if auth_session is not None:
+                    # Browsers get a standard cookie for session.
+                    self.send_header(
+                        "Set-Cookie",
+                        "{0}={1}; Path=/".format(
+                            session_manager.SESSION_COOKIE_NAME,
+                            auth_session.token))
+
             SimpleHTTPRequestHandler.do_GET(self)
 
     def do_POST(self):
@@ -558,6 +580,14 @@ def get_product(self, endpoint):
         """
         return self.__products.get(endpoint, None)
 
+    def get_only_product(self):
+        """
+        Returns the Product object for the only product connected to by the
+        server, or None, if there are 0 or >= 2 products managed.
+        """
+        return self.__products.items()[0][1] if len(self.__products) == 1 \
+            else None
+
 
 def start_server(package_data, port, db_conn_string, suppress_handler,
                  listen_address, context, check_env):

diff --git a/www/index.html b/www/index.html
@@ -40,6 +40,8 @@
   <script type="text/javascript" src="scripts/codechecker-api/codeCheckerDBAccess.js"></script>
   <script type="text/javascript" src="scripts/codechecker-api/authentication_types.js"></script>
   <script type="text/javascript" src="scripts/codechecker-api/codeCheckerAuthentication.js"></script>
+  <script type="text/javascript" src="scripts/codechecker-api/products_types.js"></script>
+  <script type="text/javascript" src="scripts/codechecker-api/codeCheckerProductService.js"></script>
 
   <!-- Configure Dojo -->
 

diff --git a/www/products.html b/www/products.html
@@ -0,0 +1,102 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CodeChecker</title>
+
+  <meta charset="UTF-8">
+
+  <link rel="shortcut icon" href="images/favicon.ico" />
+
+  <!-- CSS -->
+
+  <link type="text/css" rel="stylesheet" href="scripts/plugins/dojo/dijit/themes/claro/claro.css" />
+  <link type="text/css" rel="stylesheet" href="scripts/plugins/dojo/dojox/grid/resources/claroGrid.css"/>
+  <link type="text/css" rel="stylesheet" href="style/codecheckerviewer.css" />
+  <link type="text/css" rel="stylesheet" href="style/productlist.css" />
+
+  <!-- Third party libraries -->
+
+  <script type="text/javascript" src="scripts/plugins/jsplumb/external/jquery-1.9.0-min.js"></script>
+  <script type="text/javascript" src="scripts/plugins/jsplumb/jquery.jsPlumb-1.7.6-min.js"></script>
+  <script type="text/javascript" src="scripts/plugins/thrift/thrift.js"></script>
+  <script type="text/javascript" src="scripts/plugins/marked/marked.min.js"></script>
+
+  <!-- Services -->
+
+  <script type="text/javascript" src="scripts/codechecker-api/shared_types.js"></script>
+  <script type="text/javascript" src="scripts/codechecker-api/products_types.js"></script>
+  <script type="text/javascript" src="scripts/codechecker-api/codeCheckerProductService.js"></script>
+  <script type="text/javascript" src="scripts/codechecker-api/authentication_types.js"></script>
+  <script type="text/javascript" src="scripts/codechecker-api/codeCheckerAuthentication.js"></script>
+
+  <!-- Configure Dojo -->
+
+  <script>
+    var dojoConfig = {
+      baseUrl : '',
+      async : true,
+      packages : [
+        { name : 'dojo',  location : 'scripts/plugins/dojo/dojo'  },
+        { name : 'dijit', location : 'scripts/plugins/dojo/dijit' },
+        { name : 'dojox', location : 'scripts/plugins/dojo/dojox' },
+        { name : 'codechecker', location : 'scripts/codecheckerviewer' },
+        { name : 'products', location : 'scripts/productlist' }
+      ]
+    };
+  </script>
+
+  <script type="text/javascript" src="scripts/plugins/dojo/dojo/dojo.js"></script>
+
+  <!-- End loading custom scripts -->
+</head>
+<body class="claro">
+  <script>
+    // http://stackoverflow.com/questions/5916900/how-can-you-detect-the-version-of-a-browser
+    var browserVersion = (function(){
+      var ua = navigator.userAgent, tem, 
+        M = ua.match(/(opera|chrome|safari|firefox|msie|trident(?=\/))\/?\s*(\d+)/i) || [];
+
+      if (/trident/i.test(M[1])) {
+        tem = /\brv[ :]+(\d+)/g.exec(ua) || [];
+        return 'IE ' + (tem[1] || '');
+      }
+
+      if (M[1] === 'Chrome') {
+        tem = ua.match(/\b(OPR|Edge)\/(\d+)/);
+        if (tem != null) return tem.slice(1).join(' ').replace('OPR', 'Opera');
+      }
+
+      M = M[2] ? [M[1], M[2]] : [navigator.appName, navigator.appVersion, '-?'];
+      if ((tem = ua.match(/version\/(\d+)/i)) != null) M.splice(1, 1, tem[1]);
+        return M.join(' ');
+    })();
+
+    var pos = browserVersion.indexOf(' ');
+    var browser = browserVersion.substr(0, pos);
+    var version = parseInt(browserVersion.substr(pos + 1));
+
+    var browserCompatible
+      = browser === 'Firefox'
+      ? version >= 4
+      : browser === 'IE'
+      ? version >= 9
+      : true;
+
+    if (browserCompatible) {
+      require([
+        'products/productlist'],
+      function (productlist) {
+        productlist();
+      });
+    } else {
+      document.body.innerHTML =
+        '<h2 style="margin-left: 20px;">Your browser is not compatible with CodeChecker Viewer!</h2> \
+         <p style="margin-left: 20px;">The version required for the following browsers are:</p> \
+         <ul style="margin-left: 20px;"> \
+         <li>Internet Explorer: version 9 or newer</li> \
+         <li>Firefox: version 4 or newer</li> \
+         </ul>';
+    }
+  </script>
+</body>
+</html>
diff --git a/www/scripts/codecheckerviewer/CommentView.js b/www/scripts/codecheckerviewer/CommentView.js
@@ -20,9 +20,9 @@ define([
   'dijit/tree/ObjectStoreModel',
   'codechecker/HtmlTree',
   'codechecker/util'],
-function (declare, dom, style, topic, Memory, Observable, ConfirmDialog, Dialog,
-  ContentPane, Button, SimpleTextarea, TextBox, ObjectStoreModel, HtmlTree,
-  util) {
+function (declare, dom, style, topic, Memory, Observable, ConfirmDialog,
+  Dialog, ContentPane, Button, SimpleTextarea, TextBox, ObjectStoreModel,
+  HtmlTree, util) {
 
   var Reply = declare(ContentPane, {
     constructor : function () {
@@ -207,4 +207,4 @@ function (declare, dom, style, topic, Memory, Observable, ConfirmDialog, Dialog,
       });
     }
   });
-});
+});
diff --git a/www/scripts/codecheckerviewer/ListOfRuns.js b/www/scripts/codecheckerviewer/ListOfRuns.js
@@ -20,25 +20,6 @@ define([
 function (declare, domConstruct, ItemFileWriteStore, topic, Dialog, Button,
   RadioButton, TextBox, BorderContainer, ContentPane, DataGrid, util) {
 
-  function prettifyDuration(seconds) {
-    var prettyDuration = "--------";
-
-    if (seconds >= 0) {
-      var durHours = Math.floor(seconds / 3600);
-      var durMins  = Math.floor(seconds / 60) - durHours * 60;
-      var durSecs  = seconds - durMins * 60 - durHours * 3600;
-
-      var prettyDurHours = (durHours < 10 ? '0' : '') + durHours;
-      var prettyDurMins  = (durMins  < 10 ? '0' : '') + durMins;
-      var prettyDurSecs  = (durSecs  < 10 ? '0' : '') + durSecs;
-
-      prettyDuration
-        = prettyDurHours + ':' + prettyDurMins + ':' + prettyDurSecs;
-    }
-
-    return prettyDuration;
-  }
-
   /**
    * This function helps to format a data grid cell with two radio buttons.
    * @param args {runData, listOfRunsGrid} - the value from the data store that
@@ -188,7 +169,7 @@ function (declare, domConstruct, ItemFileWriteStore, topic, Dialog, Button,
         name         : '<span class="link">' + runData.name + '</span>',
         date         : currItemDate[0] + ' ' + currItemDate[1],
         numberofbugs : runData.resultCount,
-        duration     : prettifyDuration(runData.duration),
+        duration     : util.prettifyDuration(runData.duration),
         runData      : runData,
         checkcmd     : '<span class="link">Show</span>',
         del          : false,