Aggregregate metrics on all branches

modules/tracker/Notification.php

@@ -23,7 +23,10 @@
 /**
  * Notification manager for the tracker module.
  *
+ * @property Tracker_AggregateMetricModel $Tracker_AggregateMetric
+ * @property Tracker_AggregateMetricSpecModel $Tracker_AggregateMetricSpec
  * @property Tracker_ScalarModel $Tracker_Scalar
+ * @property Tracker_SubmissionModel $Tracker_Submission
  * @property Tracker_TrendModel $Tracker_Trend
  */
 class Tracker_Notification extends ApiEnabled_Notification
@@ -35,7 +38,7 @@ class Tracker_Notification extends ApiEnabled_Notification
     public $_models = array('User');
 
     /** @var array */
-    public $_moduleModels = array('Scalar', 'Trend', 'AggregateMetricSpec', 'AggregateMetric');
+    public $_moduleModels = array('AggregateMetric', 'AggregateMetricNotification', 'AggregateMetricSpec', 'Scalar', 'Submission', 'Trend');
 
     /** @var array */
     public $_moduleComponents = array('Api');
@@ -94,7 +97,7 @@ public function communityDeleted($args)
     }
 
     /**
-     * When an item is deleted, we must delete associated item2scalar records.
+     * When an item is deleted, we must delete associated item2submission records.
      *
      * @todo
      * @param array $args associative array of parameters including the key "item"
@@ -221,27 +224,37 @@ public function sendAggregateEmail($params)
         $userDao = $this->User->load($params['recipient_id']);
         if ($userDao === false) {
             $this->getLogger()->warn(
-                'Attempting to send aggregate metric threshold notification to user id '.$params['recipientId'].': No such user.'
+                'Attempting to send aggregate metric threshold notification to user id '.$params['recipient_id'].': No such user.'
+            );
+
+            return;
+        }
+
+        /** @var Tracker_AggregateMetricDao $aggregateMetricDao */
+        $aggregateMetricDao = $this->Tracker_AggregateMetric->load($params['aggregate_metric_id']);
+        if ($aggregateMetricDao === false) {
+            $this->getLogger()->warn(
+                'Attempting to send aggregate metric threshold notification with aggregate metric '.$params['aggregate_metric_id'].': No such metric.'
             );
 
             return;
         }
 
         /** @var Tracker_AggregateMetricSpecDao $aggregateMetricSpecDao */
-        $aggregateMetricSpecDao = $this->Tracker_AggregateMetricSpec->load($params['aggregate_metric_spec_id']);
+        $aggregateMetricSpecDao = $aggregateMetricDao->getAggregateMetricSpec();
         if ($aggregateMetricSpecDao === false) {
             $this->getLogger()->warn(
-                'Attempting to send aggregate metric threshold notification with aggregate metric spec '.$params['aggregateMetricSpecId'].': No such spec.'
+                'Attempting to send aggregate metric threshold notification with aggregate metric spec that does not exist.'
             );
 
             return;
         }
 
-        /** @var Tracker_AggregateMetricDao $aggregateMetricDao */
-        $aggregateMetricDao = $this->Tracker_AggregateMetric->load($params['aggregate_metric_id']);
+        /** @var Tracker_AggregateMetricNotificationDao $aggregateMetricNotificationDao */
+        $aggregateMetricNotificationDao = $this->Tracker_AggregateMetricNotification->load($params['aggregate_metric_notification_id']);
         if ($aggregateMetricDao === false) {
             $this->getLogger()->warn(
-                'Attempting to send aggregate metric threshold notification with aggregate metric '.$params['aggregateMetricId'].': No such metric.'
+                'Attempting to send aggregate metric threshold notification with aggregate metric notification id '.$params['aggregate_metric_notification_id'].': No such notification.'
             );
 
             return;
@@ -254,9 +267,9 @@ public function sendAggregateEmail($params)
 
         $producerName = $producerDao->getDisplayName();
         $metricName = $aggregateMetricSpecDao->getName();
-        $branch = $aggregateMetricSpecDao->getBranch();
-        $thresholdValue = $aggregateMetricSpecDao->getValue();
-        $thresholdComparison = $aggregateMetricSpecDao->getComparison();
+        $thresholdValue = $aggregateMetricNotificationDao->getValue();
+        $thresholdComparison = $aggregateMetricNotificationDao->getComparison();
+        $branch = $aggregateMetricNotificationDao->getBranch();
         $metricValue = $aggregateMetricDao->getValue();
         $subject = 'Threshold Alert: '.$producerName.': '.$metricName;
 

modules/tracker/configs/module.ini

@@ -6,4 +6,4 @@ description = "Track scalar results over time"
 category = "Visualization"
 dependencies = api,scheduler
 uuid = "3048a9fa-89ab-4e61-a55e-a49379fa6dc"
-version = "1.2.4"
+version = "2.0.1"

modules/tracker/controllers/ProducerController.php

@@ -92,7 +92,7 @@ public function viewAction()
         }
 
         $this->view->producer = $producerDao;
-        $this->view->trendGroups = $this->Tracker_Trend->getTrendsGroupByDatasets($producerDao);
+        $this->view->trendGroups = $this->Tracker_Trend->getTrendsByGroup($producerDao);
         $this->view->isAdmin = $this->Tracker_Producer->policyCheck($producerDao, $this->userSession->Dao, MIDAS_POLICY_ADMIN);
         $this->view->json['tracker']['producer'] = $producerDao;
 

modules/tracker/controllers/ScalarController.php

@@ -22,11 +22,12 @@
  * Scalar controller for the tracker module.
  *
  * @property Tracker_ScalarModel $Tracker_Scalar
+ * @property Tracker_SubmissionModel $Tracker_Submission
  */
 class Tracker_ScalarController extends Tracker_AppController
 {
     /** @var array */
-    public $_moduleModels = array('Scalar');
+    public $_moduleModels = array('Scalar', 'Submission');
 
     /**
      * Display the dialog of scalar details, including associated result items with thumbnails.
@@ -50,18 +51,23 @@ public function detailsAction()
         /** @var Tracker_ScalarDao $scalarDao */
         $scalarDao = $this->Tracker_Scalar->load($scalarId);
 
+        /** @var Tracker_SubmissionDao $submissionDao */
+        $submissionDao = $this->Tracker_Submission->load($scalarDao->getSubmissionId());
+
         if ($this->Tracker_Scalar->policyCheck($scalarDao, $this->userSession->Dao, MIDAS_POLICY_READ) === false
         ) {
             throw new Zend_Exception('The scalar does not exist or you do not have the necessary permission', 403);
         }
 
         $this->view->isAdmin = $this->Tracker_Scalar->policyCheck($scalarDao, $this->userSession->Dao, MIDAS_POLICY_ADMIN);
+
         $this->view->scalar = $scalarDao;
-        $this->view->extraParams = $scalarDao->getParams();
-        $this->view->extraUrls = json_decode($scalarDao->getExtraUrls(), true);
+        $this->view->submission = $submissionDao;
+        $this->view->extraParams = $submissionDao->getParams();
+        $this->view->extraUrls = json_decode($submissionDao->getExtraUrls(), true);
 
-        $revisionUrl = $scalarDao->getTrend()->getProducer()->getRevisionUrl();
-        $producerRevision = $scalarDao->getProducerRevision();
+        $revisionUrl = $submissionDao->getProducer()->getRevisionUrl();
+        $producerRevision = $submissionDao->getProducerRevision();
 
         if (!is_null($revisionUrl)) {
             $producerRevisionUrl = preg_replace('/%revision/', $producerRevision, $revisionUrl);
@@ -70,11 +76,10 @@ public function detailsAction()
             $this->view->revisionHtml = $producerRevision;
         }
 
-        $this->view->resultItems = $this->Tracker_Scalar->getAssociatedItems($scalarDao);
-        $this->view->otherValues = $this->Tracker_Scalar->getOtherValuesFromSubmission($scalarDao);
+        $this->view->otherValues = $this->Tracker_Submission->getValuesFromSubmission($submissionDao);
 
-        if ($scalarDao->getUserId() !== -1) {
-            $this->view->submittedBy = $scalarDao->getUser();
+        if ($submissionDao->getUserId() !== -1) {
+            $this->view->submittedBy = $submissionDao->getUser();
         } else {
             $this->view->submittedBy = null;
         }

modules/tracker/controllers/TrendController.php

@@ -24,14 +24,16 @@
  * @property Tracker_ScalarModel $Tracker_Scalar
  * @property Tracker_ThresholdNotificationModel $Tracker_ThresholdNotification
  * @property Tracker_TrendModel $Tracker_Trend
+ * @property Tracker_SubmissionModel $Tracker_Submission
+ * @property Tracker_ProducerModel $Tracker_Producer
  */
 class Tracker_TrendController extends Tracker_AppController
 {
     /** @var array */
     public $_components = array('Breadcrumb');
 
     /** @var array */
-    public $_moduleModels = array('Producer', 'Scalar', 'ThresholdNotification', 'Trend');
+    public $_moduleModels = array('Producer', 'Scalar', 'ThresholdNotification', 'Trend', 'Submission');
 
     /**
      * View a given trend.
@@ -81,7 +83,7 @@ public function viewAction()
 
         $userId = $this->userSession->Dao ? $this->userSession->Dao->getKey() : null;
 
-        $this->view->allBranches = $this->Tracker_Scalar->getDistinctBranches();
+        $this->view->allBranches = $this->Tracker_Submission->getDistinctBranches();
 
         $trendIds = explode(' ', trim(str_replace(',', ' ', $trendId)));
         $trendDaos = array();
@@ -104,15 +106,15 @@ public function viewAction()
             );
 
             if (!isset($this->view->json['tracker']['producerId'])) {
-                $this->view->json['tracker']['producerId'] = $trendDao->getProducerId();
+                $this->view->json['tracker']['producerId'] = $trendDao->getTrendgroup()->getProducerId();
             }
 
             $trendDaos[] = $trendDao;
         }
 
         /** @var Tracker_TrendDao $trendDao */
         $trendDao = $trendDaos[0];
-        $producerDao = $trendDao->getProducer();
+        $producerDao = $trendDao->getTrendgroup()->getProducer();
         $communityDao = $producerDao->getCommunity();
 
         if (count($trendDaos) === 1) {
@@ -131,7 +133,7 @@ public function viewAction()
             /** @var Tracker_TrendDao $rightTrendDao */
             $rightTrendDao = $this->Tracker_Trend->load($rightTrendId);
 
-            if ($communityDao !== false && $communityDao->getKey() !== $rightTrendDao->getProducer()->getCommunityId()
+            if ($communityDao !== false && $communityDao->getKey() !== $rightTrendDao->getTrendgroup()->getProducer()->getCommunityId()
             ) {
                 throw new Zend_Exception('The right trend must belong to the same community as the other trends', 403);
             }
@@ -555,8 +557,11 @@ public function setkeymetricAction()
         /** @var Tracker_TrendDao $trendDao */
         $trendDao = $this->Tracker_Trend->load($trendId);
 
+        /** @var Tracker_TrendgroupDao $trendGroup */
+        $trendGroup = $trendDao->getTrendgroup();
+
         /** @var Tracker_ProducerDao $producerDao */
-        $producerDao = $trendDao->getProducer();
+        $producerDao = $trendGroup->getProducer();
 
         if ($this->Tracker_Producer->policyCheck($producerDao, $this->userSession->Dao, MIDAS_POLICY_ADMIN) === false
         ) {

modules/tracker/controllers/api/AggregatemetricnotificationController.php

@@ -0,0 +1,103 @@
+<?php
+/*=========================================================================
+ Midas Server
+ Copyright Kitware SAS, 26 rue Louis Guérin, 69100 Villeurbanne, France.
+ All rights reserved.
+ For more information visit http://www.kitware.com/.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0.txt
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+=========================================================================*/
+
+/** API aggregateMetricNotification controller for the tracker module. */
+class Apitracker_AggregatemetricnotificationController extends ApiController
+{
+    /** @var string */
+    public $moduleName = 'tracker';
+
+    /** Handle HTTP DELETE requests. Requires an id parameter. */
+    public function deleteAction()
+    {
+        $this->_genericAction(
+            $this->_request->getParams(),
+            $this->_request->getControllerName(),
+            $this->_request->getActionName(),
+            array('default' => $this->_request->getActionName()),
+            $this->moduleName,
+            false
+        );
+    }
+
+    /** Handle HTTP GET requests. Requires an id parameter. */
+    public function getAction()
+    {
+        $this->_genericAction(
+            $this->_request->getParams(),
+            $this->_request->getControllerName(),
+            $this->_request->getActionName(),
+            array('default' => $this->_request->getActionName()),
+            $this->moduleName,
+            false
+        );
+    }
+
+    /** Handle HTTP HEAD requests. */
+    public function headAction()
+    {
+        $this->_response->setHttpResponseCode(200); // 200 OK
+    }
+
+    /** Handle HTTP GET index or list requests. */
+    public function indexAction()
+    {
+        $this->_genericAction(
+            $this->_request->getParams(),
+            $this->_request->getControllerName(),
+            $this->_request->getActionName(),
+            array('default' => $this->_request->getActionName()),
+            $this->moduleName,
+            false
+        );
+    }
+
+    /** Handle HTTP OPTIONS requests. */
+    public function optionsAction()
+    {
+        $this->_response->setHeader('Allow', 'DELETE, GET, HEAD, OPTIONS, POST, PUT');
+    }
+
+    /** Handle HTTP POST requests. */
+    public function postAction()
+    {
+        $this->_genericAction(
+            $this->_request->getParams(),
+            $this->_request->getControllerName(),
+            $this->_request->getActionName(),
+            array('default' => $this->_request->getActionName()),
+            $this->moduleName,
+            false
+        );
+    }
+
+    /** Handle HTTP PUT requests. Requires an id parameter. */
+    public function putAction()
+    {
+        $this->_genericAction(
+            $this->_request->getParams(),
+            $this->_request->getControllerName(),
+            $this->_request->getActionName(),
+            array('default' => $this->_request->getActionName()),
+            $this->moduleName,
+            false
+        );
+    }
+}