Added functionality to add aggregated data to get requests (#1214)

Author: jessevz

src/inc/apiv2/common/AbstractBaseAPI.class.php

@@ -120,6 +120,14 @@ protected function getFeatures(): array
     return $features;
   }
 
+  /**
+   * Overidable function to aggregate data in the object. Currently only used for Tasks
+   * returns the aggregated data in key value pairs
+   */
+  public static function aggregateData(object $object): array {
+    return [];
+  }
+
   /**
    * Take all the dba features and converts them to a list.
    * It uses the data from the generator and replaces the keys with the aliasses.
@@ -517,6 +525,9 @@ protected function obj2Resource(object $obj, array $expandResult = [])
       $attributes[$feature['alias']] = $apiClass::db2json($feature, $kv[$name]);
     }
 
+    //TODO: only aggregate data when it has been included
+    $aggregatedData = $apiClass::aggregateData($obj);
+    $attributes = array_merge($attributes, $aggregatedData);
 
     /* Build JSON::API relationship resource */
     $toManyRelationships = $apiClass::getToManyRelationships();
@@ -890,6 +901,7 @@ protected function getPrimaryKey(): string
         return $key;
       }
     }
+    throw new HTException("Internal error: no primary key found");
   }
 
   function getFilters(Request $request) {
@@ -899,7 +911,6 @@ function getFilters(Request $request) {
   /**
    * Check for valid filter parameters and build QueryFilter
    */
-  // protected function makeFilter(Request $request, array $features): array
   protected function makeFilter(array $filters, object $apiClass): array
   {
     $qFs = []; 

src/inc/apiv2/common/AbstractModelAPI.class.php

@@ -159,6 +159,7 @@ protected function getPrimaryKeyOther(string $dbaClass): string
         return $key;
       }
     }
+    throw new HTException("Internal error: no primary key found");
   }
 
   /**

src/inc/apiv2/model/tasks.routes.php

@@ -11,6 +11,7 @@
 use DBA\Speed;
 use DBA\Task;
 use DBA\TaskWrapper;
+use Util;
 
 require_once(dirname(__FILE__) . "/../common/AbstractModelAPI.class.php");
 
@@ -125,6 +126,13 @@ protected function createObject(array $data): int {
       return $object->getId();
     }
 
+    static function aggregateData(object $object): array {
+      $aggregatedData["Dispatched"] = Util::showperc($object->getKeyspaceProgress(), $object->getKeyspace());
+      $aggregatedData["Searched"] = Util::showperc(TaskUtils::getTaskProgress($object), $object->getKeyspace());
+
+      return $aggregatedData;
+    }
+
     protected function deleteObject(object $object): void {
       TaskUtils::deleteTask($object);
     }

src/inc/utils/TaskUtils.class.php

@@ -25,6 +25,7 @@
 use DBA\TaskDebugOutput;
 use DBA\Factory;
 use DBA\Speed;
+use DBA\Aggregation;
 
 class TaskUtils {
   /**
@@ -1393,4 +1394,14 @@ public static function isSaturatedByOtherAgents($task, $agent) {
     return ($task->getIsSmall() == 1 && $numAssignments > 0) || // at least one agent is already assigned here
       ($task->getMaxAgents() > 0 && $numAssignments >= $task->getMaxAgents()); // at least maxAgents agents are already assigned
   }
+
+  public static function getTaskProgress($task) {
+    $qF1 = new QueryFilter(Chunk::TASK_ID, $task->getId(), "=");
+    
+    $agg1 = new Aggregation(Chunk::CHECKPOINT, Aggregation::SUM);
+    $agg2 = new Aggregation(Chunk::SKIP, Aggregation::SUM);
+    $results = Factory::getChunkFactory()->multicolAggregationFilter([Factory::FILTER => $qF1], [$agg1, $agg2]);
+    $progress = $results[$agg1->getName()] - $results[$agg2->getName()];
+    return $progress;
+  }
 }