ENH: refs #917. Schedule temp/unofficial scalars for deletion

Author: zachmullen

modules/tracker/Notification.php

@@ -16,7 +16,7 @@ class Tracker_Notification extends ApiEnabled_Notification
   {
   public $moduleName = 'tracker';
   public $_models = array('User');
-  public $_moduleModels = array('Trend');
+  public $_moduleModels = array('Scalar', 'Trend');
   public $_moduleComponents = array('Api');
 
   /** init notification process*/
@@ -33,6 +33,7 @@ public function init()
     $this->addCallBack('CALLBACK_CORE_USER_DELETED', 'userDeleted');
 
     $this->addTask('TASK_TRACKER_SEND_THRESHOLD_NOTIFICATION', 'sendEmail', 'Send threshold violation email');
+    $this->addTask('TASK_TRACKER_DELETE_TEMP_SCALAR', 'deleteTempScalar', 'Delete an unofficial/temporary scalar value');
     $this->enableWebAPI($this->moduleName);
     }//end init
 
@@ -72,6 +73,17 @@ public function userDeleted($args)
     $user = $args['userDao'];
     }
 
+  /**
+   * Delete temporary (unofficial) scalars after n hours, where n is specified as
+   * a module configuration option
+   */
+  public function deleteTempScalar($params)
+    {
+    $scalarId = $params['scalarId'];
+    $scalar = $this->Tracker_Scalar->load($scalarId);
+    $this->Tracker_Scalar->delete($scalar);
+    }
+
   /**
    * Send an email to the user that a threshold was crossed
    */

modules/tracker/controllers/components/ApiComponent.php

@@ -204,6 +204,29 @@ public function scalarAdd($args)
       $notifyComponent = MidasLoader::loadComponent('ThresholdNotification', 'tracker');
       $notifyComponent->scheduleNotifications($scalar, $notifications);
       }
+    if(!$official)
+      {
+      $jobModel = MidasLoader::loadModel('Job', 'scheduler');
+      $settingModel = MidasLoader::loadModel('Setting');
+      $nHours = $settingModel->getValueByName('tempScalarTtl', 'tracker');
+      if(!$nHours)
+        {
+        $nHours = 24; //default to 24 hours
+        }
+      foreach($notifications as $notification)
+        {
+        $job = MidasLoader::newDao('JobDao', 'scheduler');
+        $job->setTask('TASK_TRACKER_DELETE_TEMP_SCALAR');
+        $job->setPriority(1);
+        $job->setRunOnlyOnce(1);
+        $job->setFireTime(date('Y-m-j G:i:s', strtotime('+'.$nHours.' hours')));
+        $job->setTimeInterval(0);
+        $job->setStatus(SCHEDULER_JOB_STATUS_TORUN);
+        $job->setCreatorId($user->getKey());
+        $job->setParams(JsonComponent::encode(array('scalarId' => $scalar->getKey())));
+        $jobModel->save($job);
+        }
+      }
     return $scalar;
     }
 
@@ -229,6 +252,16 @@ public function resultsUploadJson($args)
     $user = $this->_getUser($args);
 
     $official = !array_key_exists('unofficial', $args);
+    if(!$official)
+      {
+      $jobModel = MidasLoader::loadModel('Job', 'scheduler');
+      $settingModel = MidasLoader::loadModel('Setting');
+      $nHours = $settingModel->getValueByName('tempScalarTtl', 'tracker');
+      if(!$nHours)
+        {
+        $nHours = 24; //default to 24 hours
+        }
+      }
 
     // Unofficial submissions only require read access to the community
     $community = $communityModel->load($args['communityId']);
@@ -362,6 +395,22 @@ public function resultsUploadJson($args)
             $notifyComponent = MidasLoader::loadComponent('ThresholdNotification', 'tracker');
             $notifyComponent->scheduleNotifications($scalar, $notifications);
             }
+          if(!$official)
+            {
+            foreach($notifications as $notification)
+              {
+              $job = MidasLoader::newDao('JobDao', 'scheduler');
+              $job->setTask('TASK_TRACKER_DELETE_TEMP_SCALAR');
+              $job->setPriority(1);
+              $job->setRunOnlyOnce(1);
+              $job->setFireTime(date('Y-m-j G:i:s', strtotime('+'.$nHours.' hours')));
+              $job->setTimeInterval(0);
+              $job->setStatus(SCHEDULER_JOB_STATUS_TORUN);
+              $job->setCreatorId($user->getKey());
+              $job->setParams(JsonComponent::encode(array('scalarId' => $scalar->getKey())));
+              $jobModel->save($job);
+              }
+            }
           }
         }
       }