User Dashboard - Summary Statistics Portlet

classes/DataWarehouse/Query/Query.php

@@ -1157,10 +1157,6 @@ protected function setDuration($start_date, $end_date)
             $end_date_parsed['year']
         );
 
-        if ($this->_start_date_ts > $this->_end_date_ts) {
-            throw new \Exception("Invalid Date: start_date must be before end_date");
-        }
-
         list($this->_min_date_id, $this->_max_date_id) = $this->_aggregation_unit->getDateRangeIds($this->_start_date, $this->_end_date);
 
         if (!$start_date_given && !$end_date_given) {

classes/Rest/Controllers/BaseControllerProvider.php

@@ -2,6 +2,7 @@
 
 namespace Rest\Controllers;
 
+use DateTime;
 use Rest\Utilities\Authentication;
 use Rest\Utilities\Authorization;
 use Silex\Application;
@@ -551,7 +552,7 @@ protected function getDateTimeFromUnixParam(Request $request, $name, $mandatory
             FILTER_CALLBACK,
             array(
                 "options" => function ($value) {
-                    $value_dt = \DateTime::createFromFormat('U', $value);
+                    $value_dt = DateTime::createFromFormat('U', $value);
                     if ($value_dt === false) {
                         return null;
                     }
@@ -705,4 +706,52 @@ public function formatLogMesssage($message, Request $request, $includeParams = f
         return $retval;
 
     }  // formatLogMessage()
+
+    /**
+     * Checks that the `$[start|end]Date` values are valid ( `Y-m-d` ) dates and that `$startDate`
+     * is before `$endDate`.
+     *
+     * @param string $startDate the beginning of the date range.
+     * @param string $endDate   the end of the date range.
+     * @throws BadRequestHttpException if either start or end dates are not provided in the format
+     * `Y-m-d`, or if the start date is after the end date.
+     */
+    protected function checkDateRange($startDate, $endDate)
+    {
+        $startTimestamp = $this->getTimestamp($startDate, 'start_date');
+        $endTimestamp = $this->getTimestamp($endDate, 'end_date');
+
+        if ($startTimestamp > $endTimestamp) {
+            throw new BadRequestHttpException('Start Date must not be after End Date');
+        }
+    }
+
+    /**
+     * Attempt to convert the provided string $date value into an equivalent unix timestamp (int).
+     *
+     * @param string $date              The value to be converted into a DateTime.
+     * @param string $paramName 'date', The name of the parameter to be included in the exception
+     *                                  message if validation fails.
+     * @param string $format 'Y-m-d',   The format that `$date` should be in.
+     * @return int created from the provided `$date` value.
+     * @throws BadRequestHttpException if the date is not in the form `Y-m-d`.
+     */
+    protected function getTimestamp($date, $paramName = 'date', $format = 'Y-m-d')
+    {
+        $parsed = date_parse_from_format($format, $date);
+        $date = mktime(
+            $parsed['hour'],
+            $parsed['minute'],
+            $parsed['second'],
+            $parsed['month'],
+            $parsed['day'],
+            $parsed['year']
+        );
+
+        if ($date === false || $parsed['error_count'] > 0) {
+            throw new BadRequestHttpException("Unable to parse $paramName");
+        }
+
+        return $date;
+    }
 }

classes/Rest/Controllers/SummaryControllerProvider.php

@@ -2,12 +2,15 @@
 
 namespace Rest\Controllers;
 
+use Configuration\XdmodConfiguration;
+use Exception;
+use PDOException;
 use Silex\Application;
 use Silex\ControllerCollection;
 use Symfony\Component\HttpFoundation\Request;
-use DataWarehouse\Query\Exceptions\BadRequestException;
 
 use Models\Services\Acls;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
 class SummaryControllerProvider extends BaseControllerProvider
 {
@@ -23,6 +26,8 @@ public function setupRoutes(Application $app, ControllerCollection $controller)
 
         $controller->post("$root/layout", "$class::setLayout");
         $controller->delete("$root/layout", "$class::resetLayout");
+
+        $controller->get("$root/statistics", "$class::getStatistics");
     }
 
     /*
@@ -191,4 +196,58 @@ public function resetLayout(Request $request, Application $app)
             'total' => 1
         ));
     }
+
+    /**
+     * Retrieve summary statistics
+     *
+     * @param Request $request
+     * @param Application $app
+     * @return \Symfony\Component\HttpFoundation\JsonResponse
+     * @throws Exception
+     */
+    public function getStatistics(Request $request, Application $app)
+    {
+        $user = $this->getUserFromRequest($request);
+
+        $aggregationUnit = $request->get('aggregation_unit', 'auto');
+
+        $startDate = $this->getStringParam($request, 'start_date', true);
+        $endDate = $this->getStringParam($request, 'end_date', true);
+
+        $this->checkDateRange($startDate, $endDate);
+
+        // This try/catch block is intended to replace the "Base table or
+        // view not found: 1146 Table 'modw_aggregates.jobfact_by_day'
+        // doesn't exist" error message with something more informative for
+        // Open XDMoD users.
+        try {
+            $query = new \DataWarehouse\Query\Jobs\Aggregate($aggregationUnit, $startDate, $endDate, 'none', 'all');
+
+            $result = $query->execute();
+        } catch (PDOException $e) {
+            if ($e->getCode() === '42S02' && strpos($e->getMessage(), 'modw_aggregates.jobfact_by_') !== false) {
+                $msg = 'Aggregate table not found, have you ingested your data?';
+                throw new Exception($msg);
+            } else {
+                throw $e;
+            }
+        } catch (Exception $e) {
+            throw new BadRequestHttpException($e->getMessage());
+        }
+
+        $rawRoles = XdmodConfiguration::assocArrayFactory('roles.json', CONFIG_DIR);
+
+        $mostPrivileged = $user->getMostPrivilegedRole()->getName();
+        $formats = $rawRoles['roles'][$mostPrivileged]['statistics_formats'];
+
+        return $app->json(
+            array(
+                'totalCount' => 1,
+                'success' => true,
+                'message' => '',
+                'formats' => $formats,
+                'data' => array($result)
+            )
+        );
+    }
 }