bookstack/app/Entities/Tools/EntityHydrator.php

<?php

namespace BookStack\Entities\Tools;

use BookStack\Activity\Models\Tag;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Entity;
use BookStack\Entities\Models\EntityTable;
use BookStack\Entities\Models\Page;
use BookStack\Entities\Queries\EntityQueries;
use Illuminate\Database\Eloquent\Collection;

class EntityHydrator
{
    public function __construct(
        protected EntityQueries $entityQueries,
    ) {
    }

    /**
     * Hydrate the entities of this hydrator to return a list of entities represented
     * in their original intended models.
     * @param EntityTable[] $entities
     * @return Entity[]
     */
    public function hydrate(array $entities, bool $loadTags = false, bool $loadParents = false): array
    {
        $hydrated = [];

        foreach ($entities as $entity) {
            $data = $entity->getRawOriginal();
            $instance = Entity::instanceFromType($entity->type);

            if ($instance instanceof Page) {
                $data['text'] = $data['description'];
                unset($data['description']);
            }

            $instance = $instance->setRawAttributes($data, true);
            $hydrated[] = $instance;
        }

        if ($loadTags) {
            $this->loadTagsIntoModels($hydrated);
        }

        if ($loadParents) {
            $this->loadParentsIntoModels($hydrated);
        }

        return $hydrated;
    }

    /**
     * @param Entity[] $entities
     */
    protected function loadTagsIntoModels(array $entities): void
    {
        $idsByType = [];
        $entityMap = [];
        foreach ($entities as $entity) {
            if (!isset($idsByType[$entity->type])) {
                $idsByType[$entity->type] = [];
            }
            $idsByType[$entity->type][] = $entity->id;
            $entityMap[$entity->type . ':' . $entity->id] = $entity;
        }

        $query = Tag::query();
        foreach ($idsByType as $type => $ids) {
            $query->orWhere(function ($query) use ($type, $ids) {
                $query->where('entity_type', '=', $type)
                    ->whereIn('entity_id', $ids);
            });
        }

        $tags = empty($idsByType) ? [] : $query->get()->all();
        $tagMap = [];
        foreach ($tags as $tag) {
            $key = $tag->entity_type . ':' . $tag->entity_id;
            if (!isset($tagMap[$key])) {
                $tagMap[$key] = [];
            }
            $tagMap[$key][] = $tag;
        }

        foreach ($entityMap as $key => $entity) {
            $entityTags = new Collection($tagMap[$key] ?? []);
            $entity->setRelation('tags', $entityTags);
        }
    }

    /**
     * @param Entity[] $entities
     */
    protected function loadParentsIntoModels(array $entities): void
    {
        $parentsByType = ['book' => [], 'chapter' => []];

        foreach ($entities as $entity) {
            if ($entity->getAttribute('book_id') !== null) {
                $parentsByType['book'][] = $entity->getAttribute('book_id');
            }
            if ($entity->getAttribute('chapter_id') !== null) {
                $parentsByType['chapter'][] = $entity->getAttribute('chapter_id');
            }
        }

        $parentQuery = $this->entityQueries->visibleForList();
        $filtered = count($parentsByType['book']) > 0 || count($parentsByType['chapter']) > 0;
        $parentQuery = $parentQuery->where(function ($query) use ($parentsByType) {
            foreach ($parentsByType as $type => $ids) {
                if (count($ids) > 0) {
                    $query = $query->orWhere(function ($query) use ($type, $ids) {
                        $query->where('type', '=', $type)
                            ->whereIn('id', $ids);
                    });
                }
            }
        });

        $parentModels = $filtered ? $parentQuery->get()->all() : [];
        $parents = $this->hydrate($parentModels);
        $parentMap = [];
        foreach ($parents as $parent) {
            $parentMap[$parent->type . ':' . $parent->id] = $parent;
        }

        foreach ($entities as $entity) {
            if ($entity instanceof Page || $entity instanceof Chapter) {
                $key = 'book:' . $entity->getRawAttribute('book_id');
                $entity->setAttribute('book', $parentMap[$key] ?? null);
            }
            if ($entity instanceof Page) {
                $key = 'chapter:' . $entity->getRawAttribute('chapter_id');
                $entity->setAttribute('chapter', $parentMap[$key] ?? null);
            }
        }
    }
}