ENH: refs #917. Add user_id and official fields to tracker_scalar

This will allow for user-specific experimental scalar submissions

Author: zachmullen

modules/tracker/controllers/components/ApiComponent.php

@@ -89,6 +89,7 @@ public function itemAssociate($args)
    * @param testDatasetId (Optional) If this value pertains to a specific test dataset, pass its id here
    * @param truthDatasetId (Optional) If this value pertains to a specific ground truth dataset, pass its id here
    * @param silent (Optional) If set, do not perform treshold-based email notifications for this scalar
+   * @param unofficial (Optional) If passed, creates an unofficial scalar visible only to the user performing the submission
    * @return The scalar dao that was created
    */
   public function scalarAdd($args)
@@ -98,8 +99,10 @@ public function scalarAdd($args)
     $this->_checkKeys(array('communityId', 'producerDisplayName', 'metricName', 'value', 'producerRevision', 'submitTime'), $args);
     $user = $this->_getUser($args);
 
+    $official = !array_key_exists('unofficial', $args);
+
     $community = $communityModel->load($args['communityId']);
-    if(!$community || !$communityModel->policyCheck($community, $user, MIDAS_POLICY_WRITE))
+    if(!$community || !$communityModel->policyCheck($community, $user, $official ? MIDAS_POLICY_WRITE : MIDAS_POLICY_READ))
       {
       throw new Exception('Write permission required on community', 403);
       }
@@ -192,7 +195,7 @@ public function scalarAdd($args)
     $producerRevision = trim($args['producerRevision']);
 
     $scalarModel = MidasLoader::loadModel('Scalar', 'tracker');
-    $scalar = $scalarModel->addToTrend($trend, $submitTime, $producerRevision, $value, true);
+    $scalar = $scalarModel->addToTrend($trend, $submitTime, $producerRevision, $value, $user, true, $official);
 
     if(!isset($args['silent']))
       {
@@ -215,6 +218,7 @@ public function scalarAdd($args)
    * @param truthDatasetId (Optional) If this value pertains to a specific ground truth dataset, pass its id here
    * @param parentKeys (Optional) Semicolon-separated list of parent keys to look for numeric results under.  Use '.' to denote nesting, like in normal javascript syntax.
    * @param silent (Optional) If set, do not perform treshold-based email notifications for this scalar
+   * @param unofficial (Optional) If passed, creates an unofficial scalar visible only to the user performing the submission
    * @return The list of scalars that were created.  Non-numeric values are ignored.
    */
   public function resultsUploadJson($args)
@@ -224,8 +228,11 @@ public function resultsUploadJson($args)
     $this->_checkKeys(array('communityId', 'producerDisplayName', 'producerRevision'), $args);
     $user = $this->_getUser($args);
 
+    $official = !array_key_exists('unofficial', $args);
+
+    // Unofficial submissions only require read access to the community
     $community = $communityModel->load($args['communityId']);
-    if(!$community || !$communityModel->policyCheck($community, $user, MIDAS_POLICY_WRITE))
+    if(!$community || !$communityModel->policyCheck($community, $user, $official ? MIDAS_POLICY_WRITE : MIDAS_POLICY_READ))
       {
       throw new Exception('Write permission required on community', 403);
       }
@@ -345,7 +352,7 @@ public function resultsUploadJson($args)
             continue;
             }
           $trend = $trendModel->createIfNeeded($producer->getKey(), $metricName, $configItemId, $testDatasetId, $truthDatasetId);
-          $scalar = $scalarModel->addToTrend($trend, $submitTime, $producerRevision, $value, true);
+          $scalar = $scalarModel->addToTrend($trend, $submitTime, $producerRevision, $value, $user, true, $official);
           $scalars[] = $scalar;
 
           if(!isset($args['silent']))
@@ -367,7 +374,7 @@ public function resultsUploadJson($args)
           continue;
           }
         $trend = $trendModel->createIfNeeded($producer->getKey(), $metricName, $configItemId, $testDatasetId, $truthDatasetId);
-        $scalar = $scalarModel->addToTrend($trend, $submitTime, $producerRevision, $value, true);
+        $scalar = $scalarModel->addToTrend($trend, $submitTime, $producerRevision, $value, $user, true, $official);
         $scalars[] = $scalar;
 
         if(!isset($args['silent']))

modules/tracker/database/upgrade/1.0.1.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * 1. Adds a user_id value to a scalar record indicating which user uploaded the scalar
+ * 2. Adds a binary "official" flag to a scalar record indicating if it is an official or experimental submission
+ * 3. Adds submit_time and user_id indices to the tracker_scalar table
+ */
+class Tracker_Upgrade_1_0_1 extends MIDASUpgrade
+{
+  public function preUpgrade()
+    {
+    }
+
+  public function mysql()
+    {
+    $this->db->query("ALTER TABLE `tracker_scalar` ADD COLUMN `user_id` bigint(20) NOT NULL DEFAULT -1");
+    $this->db->query("ALTER TABLE `tracker_scalar` ADD COLUMN `official` tinyint(4) NOT NULL DEFAULT 1");
+
+    $this->db->query("ALTER TABLE `tracker_scalar` ADD INDEX (`submit_time`)");
+    $this->db->query("ALTER TABLE `tracker_scalar` ADD INDEX (`user_id`)");
+    }
+
+  public function pgsql()
+    {
+    $this->db->query("ALTER TABLE tracker_scalar ADD COLUMN user_id bigint NOT NULL DEFAULT -1");
+    $this->db->query("ALTER TABLE tracker_scalar ADD COLUMN official smallint NOT NULL DEFAULT 1");
+
+    $this->db->query("CREATE INDEX tracker_scalar_idx_submit_time ON tracker_scalar (submit_time)");
+    $this->db->query("CREATE INDEX tracker_scalar_idx_user_id ON tracker_scalar (user_id)");
+    }
+
+  public function postUpgrade()
+    {
+    }
+}
+?>

modules/tracker/models/base/ScalarModelBase.php

@@ -24,32 +24,38 @@ public function __construct()
     $this->_mainData = array(
         'scalar_id' => array('type' => MIDAS_DATA),
         'trend_id' => array('type' => MIDAS_DATA),
+        'user_id' => array('type' => MIDAS_DATA),
+        'official' => array('type' => MIDAS_DATA),
         'submit_time' => array('type' => MIDAS_DATA),
         'value' => array('type' => MIDAS_DATA),
         'producer_revision' => array('type' => MIDAS_DATA),
         'trend' => array('type' => MIDAS_MANY_TO_ONE,
                          'model' => 'Trend',
                          'module' => $this->moduleName,
                          'parent_column' => 'trend_id',
-                         'child_column' => 'trend_id')
+                         'child_column' => 'trend_id'),
+        'user' => array('type' => MIDAS_MANY_TO_ONE,
+                        'model' => 'User',
+                        'parent_column' => 'user_id',
+                        'child_column' => 'user_id')
       );
     $this->initialize();
     }
 
   public abstract function associateItem($scalar, $item, $label);
   public abstract function getAssociatedItems($scalar);
   public abstract function getOtherValuesFromSubmission($scalar);
-  public abstract function getByTrendAndTimestamp($trendId, $timestamp);
+  public abstract function getByTrendAndTimestamp($trendId, $timestamp, $user = null);
 
   /**
    * Add a new scalar point to the trend.  If overwrite is true, and a scalar
    * already exists on the trend with the same submit time, this will replace that scalar value.
    */
-  public function addToTrend($trend, $submitTime, $producerRevision, $value, $overwrite = true)
+  public function addToTrend($trend, $submitTime, $producerRevision, $value, $user, $overwrite = true, $official = true)
     {
     if($overwrite)
       {
-      $dao = $this->getByTrendAndTimestamp($trend->getKey(), $submitTime);
+      $dao = $this->getByTrendAndTimestamp($trend->getKey(), $submitTime, $user->getKey());
       if($dao)
         {
         $this->delete($dao);
@@ -61,6 +67,9 @@ public function addToTrend($trend, $submitTime, $producerRevision, $value, $over
     $scalar->setSubmitTime($submitTime);
     $scalar->setProducerRevision($producerRevision);
     $scalar->setValue($value);
+    $scalar->setUserId($user instanceof UserDao ? $user->getKey() : -1);
+    $scalar->setOfficial($official ? 1 : 0);
+
     $this->save($scalar);
     return $scalar;
     }

modules/tracker/models/pdo/ScalarModel.php

@@ -52,7 +52,7 @@ public function getAssociatedItems($scalar)
     }
 
   /**
-   * Return other values that are from the same submission (same submit_time and same producer)
+   * Return other values that are from the same submission (same submit_time, producer, and user id)
    */
   public function getOtherValuesFromSubmission($scalar)
     {
@@ -61,6 +61,7 @@ public function getOtherValuesFromSubmission($scalar)
                 ->from(array('s' => 'tracker_scalar'))
                 ->join(array('t' => 'tracker_trend'), 's.trend_id = t.trend_id')
                 ->where('s.submit_time = ?', $scalar->getSubmitTime())
+                ->where('s.user_id = ?', $scalar->getUserId())
                 ->where('t.producer_id = ?', $scalar->getTrend()->getProducerId());
     $rows = $this->database->fetchAll($sql);
     $scalars = array();
@@ -83,12 +84,16 @@ public function delete($scalar)
   /**
    * Get a scalar dao based on trend and timestamp
    */
-  public function getByTrendAndTimestamp($trendId, $timestamp)
+  public function getByTrendAndTimestamp($trendId, $timestamp, $userId = null)
     {
     $sql = $this->database->select()
                 ->setIntegrityCheck(false)
                 ->where('trend_id = ?', $trendId)
                 ->where('submit_time = ?', $timestamp);
+    if($userId !== null)
+      {
+      $sql->where('user_id = ?', $userId);
+      }
     return $this->initDao('Scalar', $this->database->fetchRow($sql), $this->moduleName);
     }
 }