class.ilObjBibliographic.php

Go to the documentation of this file.

<?php

use ILIAS\Filesystem\Filesystem;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\FileUpload\Exception\IllegalStateException;
use ILIAS\ResourceStorage\Services;
use ILIAS\FileUpload\FileUpload;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ILIASObject\Properties\CoreProperties\Online;

class ilObjBibliographic extends ilObject2
{
    protected Filesystem $filesystem;
    protected FileUpload $upload_service;
    protected \ilBiblFileReaderFactory $bib_filereader_factory;
    protected \ilBiblTypeFactory $bib_type_factory;
    protected \ilBiblEntryFactory $bib_entry_factory;
    protected \ilBiblFieldFactory $bib_field_factory;
    protected \ilBiblDataFactoryInterface $bib_data_factory;
    protected \ilBiblOverviewModelFactory $bib_overview_factory;
    protected \ilBiblAttributeFactory $bib_attribute_factory;
    protected Services $storage;
    protected \ilObjBibliographicStakeholder $stakeholder;
    protected ?string $filename = null;
    protected array $entries = [];
    protected int $file_type = 0;
    protected ?ResourceIdentification $resource_id = null;
    protected bool $is_migrated = false;

    protected function initType(): void
    {
        $this->type = "bibl";
    }

    public function __construct(int $existant_bibl_id = 0)
    {
        global $DIC;

        $this->storage = $DIC->resourceStorage();
        $this->upload_service = $DIC->upload();
        $this->stakeholder = new ilObjBibliographicStakeholder();
        $this->filesystem = $DIC->filesystem()->storage();

        if ($existant_bibl_id !== 0) {
            $this->setId($existant_bibl_id);
            $this->doRead();
        }
        parent::__construct($existant_bibl_id, false);

        $this->bib_type_factory = new ilBiblTypeFactory();
        $this->bib_field_factory = new ilBiblFieldFactory($this->bib_type_factory->getInstanceForType($this->getFileType()));
        $this->bib_overview_factory = new ilBiblOverviewModelFactory();
        $this->bib_entry_factory = new ilBiblEntryFactory(
            $this->bib_field_factory,
            $this->bib_type_factory->getInstanceForType($this->getFileType()),
            $this->bib_overview_factory
        );
        $this->bib_filereader_factory = new ilBiblFileReaderFactory();
        $this->bib_attribute_factory = new ilBiblAttributeFactory($this->bib_field_factory);
    }

    private function handleUpload(): ?ResourceIdentification
    {
        if (!$this->upload_service->hasBeenProcessed()) {
            $this->upload_service->process();
        }
        $array_result = $this->upload_service->getResults();
        $result = reset($array_result); // FileUpload is the first element
        if (!$result->isOK()) {
            return null;
        }

        if ($this->getResourceId() !== null) {
            $this->storage->manage()->appendNewRevision(
                $this->getResourceId(),
                $result,
                $this->stakeholder
            );
            return $this->getResourceId();
        }

        return $this->storage->manage()->upload($result, $this->stakeholder);
    }

    protected function doCreate(bool $clone_mode = false): void
    {
        if ($this->upload_service->hasUploads()) {
            if (!$this->upload_service->hasBeenProcessed()) {
                $this->upload_service->process();
            }
            $this->setResourceId($this->handleUpload());
        }

        $this->db->insert(
            "il_bibl_data",
            [
                "id" => ["integer", $this->getId()],
                "filename" => ["text", $this->getFilename()],
                "file_type" => ["integer",
                                $this->getFilename() ? $this->determineFileTypeByFileName($this->getFilename()) : ""
                ],
                "rid" => ["string", (($rid = $this->getResourceId()) !== null) ? $rid->serialize() : ''],
            ]
        );
        $this->parseFileToDatabase();
        $this->getObjectProperties()->storePropertyIsOnline(new Online(false));
    }

    protected function doRead(): void
    {
        $bibl_data = ilBiblData::where(['id' => $this->getId()])->first();
        if (!$this->getFilename() && $bibl_data->getFilename() !== null) {
            $this->setFilename($bibl_data->getFilename());
        }
        $this->setFileType($bibl_data->getFileType());
        if (!empty($rid = $bibl_data->getResourceId()) && $id = $this->storage->manage()->find($rid)) {
            $this->setResourceId($id);
            $this->setMigrated(true);
        }
    }

    protected function doUpdate(): void
    {
        $has_valid_upload = $this->upload_service->hasUploads() && !$this->upload_service->hasBeenProcessed();

        if ($has_valid_upload) {
            $identification = $this->handleUpload();
            if ($identification instanceof ResourceIdentification) {
                $this->setResourceId($identification);
                if (!$this->isMigrated()) {
                    $this->deleteFile();
                    $this->setMigrated(true);
                }
            }
        }
        if ($has_valid_upload) {
            // Delete the object, but leave the db table 'il_bibl_data' for being able to update it using WHERE, and also leave the file
            $this->doDelete(true, true);
            $this->parseFileToDatabase();
        }

        $this->db->update(
            "il_bibl_data",
            [
                "filename" => ["text", $this->getFilename()],
                "file_type" => ["integer", $this->getFileType()],
                "rid" => ["string", (($rid = $this->getResourceId()) !== null) ? $rid->serialize() : ''],
            ],
            ["id" => ["integer", $this->getId()]]
        );
    }

    protected function doDelete(bool $leave_out_il_bibl_data = false, bool $leave_out_delete_file = false): void
    {
        if (!$leave_out_delete_file) {
            $this->deleteFile();
        }
        //il_bibl_attribute
        $this->db->manipulate(
            "DELETE FROM il_bibl_attribute WHERE il_bibl_attribute.entry_id IN "
            . "(SELECT il_bibl_entry.id FROM il_bibl_entry WHERE il_bibl_entry.data_id = " . $this->db->quote(
                $this->getId(),
                "integer"
            ) . ")"
        );
        //il_bibl_entry
        $this->bib_entry_factory->deleteEntryById($this->getId());

        if (!$leave_out_il_bibl_data) {
            //il_bibl_data
            $this->db->manipulate(
                "DELETE FROM il_bibl_data WHERE id = " . $this->db->quote($this->getId(), "integer")
            );
        }
        // delete history entries
        ilHistory::_removeEntriesForObject($this->getId());
    }

    public function getFileDirectory(): string
    {
        return "{$this->getType()}/{$this->getId()}";
    }

    private function copyFile(string $file_to_copy): void
    {
        $target = $this->getFileDirectory() . '/' . basename($file_to_copy);
        $this->filesystem->copy($file_to_copy, $target);
    }

    protected function deleteFile(): bool
    {
        $path = $this->getFileDirectory();
        try {
            $this->filesystem->deleteDir($path);
        } catch (IOException) {
            return false;
        }

        return true;
    }

    public function getFilePath(bool $without_filename = false): ?string
    {
        $file_name = $this->getFilename();

        if ($without_filename) {
            return substr((string) $file_name, 0, strrpos((string) $file_name, DIRECTORY_SEPARATOR));
        }
        return $file_name;
    }

    public function setFilename(string $filename): void
    {
        $this->filename = $filename;
    }

    public function getFilename(): ?string
    {
        if ($this->getResourceId() !== null) {
            return $this->filename = $this->storage->manage()
                                 ->getCurrentRevision($this->getResourceId())
                                 ->getInformation()
                                 ->getTitle();
        }
        return $this->filename;
    }

    public function getFileAbsolutePath(): string
    {
        return $this->getFileDirectory() . DIRECTORY_SEPARATOR . $this->getFilename();
    }

    public function getLegacyAbsolutePath()
    {
        $stream = ($this->isMigrated()) ?
            $this->storage->consume()->stream($this->getResourceId())->getStream() :
            $this->filesystem->readStream($this->getFileAbsolutePath());

        return $stream->getMetadata('uri');
    }

    public function getFileTypeAsString(): string
    {
        $type = $this->getFileType();

        return $this->bib_type_factory->getInstanceForType($type)->getStringRepresentation();
    }

    public function getFileType(): int
    {
        $filename = $this->getFilename();
        if ($filename === null) {
            return ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX;
        }
        $instance = $this->bib_type_factory->getInstanceForFileName($filename);

        return $instance->getId();
    }

    protected function doCloneObject(ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id = null): void
    {
        assert($new_obj instanceof ilObjBibliographic);
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);

        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->getObjectProperties()->storePropertyIsOnline(new Online(false));
        }

        $new_obj->cloneStructure($this->getId());
        $new_obj->parseFileToDatabase();
    }

    public function cloneStructure(int $original_id): void
    {
        $original = new ilObjBibliographic($original_id);
        $this->setFilename($original->getFilename());
        $this->setDescription($original->getDescription());
        $this->setTitle($original->getTitle());
        $this->setType($original->getType());
        $identification = $original->getResourceId();
        if ($identification instanceof ResourceIdentification) {
            $new_identification = $this->storage->manage()->clone($identification);
            $this->setResourceId($new_identification);
        } else {
            $this->copyFile($original->getFileAbsolutePath());
        }
        $this->parseFileToDatabase();
        $this->setMigrated($original->isMigrated());
        $this->doUpdate();

        // copy filters

        $filters = new ilBiblFieldFilterFactory();
        foreach ($filters->getAllForObjectId($original_id) as $filter) {
            $cloned_filter = clone $filter;
            $cloned_filter->setId(0);
            $cloned_filter->setObjectId($this->getId());
            $cloned_filter->create();
        }
    }

    public function parseFileToDatabase(): void
    {
        //Read File
        if ($this->getResourceId() === null) {
            return;
        }
        $type = $this->getFileType();
        $reader = $this->bib_filereader_factory->getByType(
            $type,
            $this->bib_entry_factory,
            $this->bib_field_factory,
            $this->bib_attribute_factory
        );
        $reader->readContent($this->getResourceId());
        $this->entries = $reader->parseContentToEntries($this);
    }

    public function setFileType(int $file_type): void
    {
        $this->file_type = $file_type;
    }

    public function setResourceId(ResourceIdentification $identification): void
    {
        $this->resource_id = $identification;
    }

    public function getResourceId(): ?ResourceIdentification
    {
        return $this->resource_id;
    }

    public function getStorageId(): string
    {
        if (!$this->getResourceId() instanceof ResourceIdentification) {
            return '-';
        }
        return $this->storage->manage()->getResource($this->getResourceId())->getStorageID();
    }

    public function isMigrated(): bool
    {
        return $this->is_migrated;
    }

    public function setMigrated(bool $migrated): void
    {
        $this->is_migrated = $migrated;
    }

    public function determineFileTypeByFileName(string $filename): int
    {
        return $this->bib_type_factory->getInstanceForFileName($filename)->getId();
    }
}