Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 58 additions & 24 deletions src/inc/apiv2/common/AbstractBaseAPI.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ protected function getUpdateHandlers($id, $current_user): array {
* Overridable 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 {
public static function aggregateData(object $object, array &$includedData=[]): array
{
return [];
}

Expand Down Expand Up @@ -553,7 +554,7 @@ protected function obj2Array(object $obj): array {
* @throws NotFoundExceptionInterface
* @throws ContainerExceptionInterface
*/
protected function obj2Resource(object $obj, array $expandResult = []): array {
protected function obj2Resource(object $obj, array &$expandResult = []): array {
// Convert values to JSON supported types
$features = $obj->getFeatures();
$kv = $obj->getKeyValueDict();
Expand Down Expand Up @@ -584,7 +585,7 @@ protected function obj2Resource(object $obj, array $expandResult = []): array {
}

//TODO: only aggregate data when it has been included
$aggregatedData = $apiClass::aggregateData($obj);
$aggregatedData = $apiClass::aggregateData($obj, $expandResult);
$attributes = array_merge($attributes, $aggregatedData);

/* Build JSON::API relationship resource */
Expand Down Expand Up @@ -1154,8 +1155,59 @@ protected function makeOrderFilterTemplates(Request $request, array $features, s

return $orderTemplates;
}



protected static function addToRelatedResources(array $relatedResources, array $relatedResource): array {
$alreadyExists = false;
$searchType = $relatedResource["type"];
$searchId = $relatedResource["id"];
foreach ($relatedResources as $resource) {
if ($resource["id"] == $searchId && $resource["type"] == $searchType) {
$alreadyExists = true;
break;
}
}
if (!$alreadyExists) {
$relatedResources[] = $relatedResource;
}
return $relatedResources;
}

protected function processExpands(
object $apiClass,
array $expands,
object $object,
array $expandResult,
array $includedResources
): array {

// Add missing expands to expands in case they have been added in aggregateData()
$expandKeys = array_keys($expandResult);
$diffs = array_diff($expandKeys, $expands);
$expands = array_merge($expandKeys, $diffs);

foreach ($expands as $expand) {
if (!array_key_exists($object->getId(), $expandResult[$expand])) {
continue;
}

$expandResultObject = $expandResult[$expand][$object->getId()];

if (is_array($expandResultObject)) {
foreach ($expandResultObject as $expandObject) {
$includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandObject));
}
} else {
if ($expandResultObject === null) {
// to-only relation which is nullable
continue;
}
$includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandResultObject));
}
}

return $includedResources;
}

/**
* Validate if user is allowed to access hashlist
* @throws HttpForbidden
Expand Down Expand Up @@ -1432,25 +1484,7 @@ protected static function getOneResource(object $apiClass, object $object, Reque
foreach ($objects as $object) {
// Create object
$newObject = $apiClass->obj2Resource($object, $expandResult);

// For compound document, included resources
foreach ($expands as $expand) {
if (array_key_exists($object->getId(), $expandResult[$expand])) {
$expandResultObject = $expandResult[$expand][$object->getId()];
if (is_array($expandResultObject)) {
foreach ($expandResultObject as $expandObject) {
$includedResources[] = $apiClass->obj2Resource($expandObject);
}
}
else {
if ($expandResultObject === null) {
// to-only relation which is nullable
continue;
}
$includedResources[] = $apiClass->obj2Resource($expandResultObject);
}
}
}
$includedResources = $apiClass->processExpands($apiClass, $expands, $object, $expandResult, $includedResources);

// Add to result output
$dataResources[] = $newObject;
Expand Down
35 changes: 1 addition & 34 deletions src/inc/apiv2/common/AbstractModelAPI.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -447,22 +447,6 @@ final protected function ResourceRecordArrayToUpdateArray($data, $parentId): arr
return $updates;
}

protected static function addToRelatedResources(array $relatedResources, array $relatedResource): array {
$alreadyExists = false;
$searchType = $relatedResource["type"];
$searchId = $relatedResource["id"];
foreach ($relatedResources as $resource) {
if ($resource["id"] == $searchId && $resource["type"] == $searchType) {
$alreadyExists = true;
break;
}
}
if (!$alreadyExists) {
$relatedResources[] = $relatedResource;
}
return $relatedResources;
}

protected static function calculate_next_cursor(string|int $cursor, bool $ascending=true) {
if (is_int($cursor)) {
if ($ascending) {
Expand Down Expand Up @@ -748,24 +732,7 @@ public static function getManyResources(object $apiClass, Request $request, Resp
foreach ($objects as $object) {
// Create object
$newObject = $apiClass->obj2Resource($object, $expandResult);

// For compound document, included resources
foreach ($expands as $expand) {
if (array_key_exists($object->getId(), $expandResult[$expand])) {
$expandResultObject = $expandResult[$expand][$object->getId()];
if (is_array($expandResultObject)) {
foreach ($expandResultObject as $expandObject) {
$includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandObject));
}
} else {
if ($expandResultObject === null) {
// to-only relation which is nullable
continue;
}
$includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandResultObject));
}
}
}
$includedResources = $apiClass->processExpands($apiClass, $expands, $object, $expandResult, $includedResources);

// Add to result output
$dataResources[] = $newObject;
Expand Down
15 changes: 15 additions & 0 deletions src/inc/apiv2/model/agents.routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use DBA\Assignment;
use DBA\Chunk;
use DBA\JoinFilter;
use DBA\QueryFilter;
use DBA\Task;
use DBA\User;
use JetBrains\PhpStorm\NoReturn;
Expand All @@ -37,6 +38,20 @@ protected function getUpdateHandlers($id, $current_user): array {
];
}

static function aggregateData(object $object, array &$included_data = []): array {
$agentId = $object->getId();
$qFs = [];
$qFs[] = new QueryFilter(Chunk::AGENT_ID, $agentId, "=");
$qFs[] = new QueryFilter(Chunk::STATE, 2, "=");

$active_chunk = Factory::getChunkFactory()->filter([Factory::FILTER => $qFs], true);
if ($active_chunk !== NULL) {
$included_data["chunks"][$agentId] = [$active_chunk];
}

return [];
}

protected function getSingleACL(User $user, object $object): bool {
$accessGroupsUser = Util::arrayOfIds(AccessUtils::getAccessGroupsOfUser($user));
/** @var Agent $object */
Expand Down
2 changes: 1 addition & 1 deletion src/inc/apiv2/model/tasks.routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ protected function createObject(array $data): int {
}

//TODO make aggregate data queryable and not included by default
static function aggregateData(object $object): array {
static function aggregateData(object $object, array &$included_data = []): array {
$qF = new QueryFilter(Assignment::TASK_ID, $object->getId(), "=");
$activeAgents = Factory::getAssignmentFactory()->countFilter([Factory::FILTER => $qF]);
$aggregatedData["activeAgents"] = $activeAgents;
Expand Down