class.ilFileXMLWriter.php

Go to the documentation of this file.

<?php

class ilFileXMLWriter extends ilXmlWriter
{
    public static int $CONTENT_ATTACH_NO = 0;
    public static int $CONTENT_ATTACH_ENCODED = 1;
    public static int $CONTENT_ATTACH_ZLIB_ENCODED = 2;
    public static int $CONTENT_ATTACH_GZIP_ENCODED = 3;
    public static int $CONTENT_ATTACH_COPY = 4;
    // begin-patch fm
    public static int $CONTENT_ATTACH_REST = 5;
    // end-patch fm

    public int $attachFileContents;
    public \ilObjFile $file;
    public $omit_header = false;
    protected ?string $target_dir_relative = null;
    protected ?string $target_dir_absolute = null;

    public function __construct()
    {
        parent::__construct();
        $this->attachFileContents = ilFileXMLWriter::$CONTENT_ATTACH_NO;
    }

    public function setFile(ilObjFile $file): void
    {
        $this->file = &$file;
    }

    public function setOmitHeader($a_val): void
    {
        $this->omit_header = $a_val;
    }

    public function getOmitHeader(): bool
    {
        return $this->omit_header;
    }

    public function setFileTargetDirectories(?string $a_rel, ?string $a_abs): void
    {
        $this->target_dir_relative = $a_rel;
        $this->target_dir_absolute = $a_abs;
    }

    public function setAttachFileContents(int $attachFileContents): void
    {
        if ($attachFileContents === ilFileXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED && !function_exists("gzencode")) {
            throw new ilFileException(
                "Inflating with gzip is not supported",
                ilFileException::$ID_DEFLATE_METHOD_MISMATCH
            );
        }
        if ($attachFileContents === ilFileXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED && !function_exists("gzcompress")) {
            throw new ilFileException(
                "Inflating with zlib (compress/uncompress) is not supported",
                ilFileException::$ID_DEFLATE_METHOD_MISMATCH
            );
        }
        $this->attachFileContents = $attachFileContents;
    }

    public function start(): bool
    {
        $this->__buildHeader();

        $attribs = [
            "obj_id" => "il_" . IL_INST_ID . "_file_" . $this->file->getId(),
            "version" => $this->file->getVersion(),
            "max_version" => $this->file->getMaxVersion(),
            "size" => $this->file->getFileSize(),
            "type" => $this->file->getFileType(),
            "action" => $this->file->getAction()
        ];

        $this->xmlStartTag("File", $attribs);
        $this->xmlElement("Filename", null, $this->file->getFileName());

        $this->xmlElement("Title", null, $this->file->getTitle());
        $this->xmlElement("Description", null, $this->file->getDescription());
        $this->xmlElement("Rating", null, (int) $this->file->hasRating());

        $versions = $this->file->getVersions();

        if ($versions !== []) {
            $this->xmlStartTag("Versions");

            foreach ($versions as $version) {
                $attribs = [
                    "version" => $version["version"],
                    "max_version" => $version["max_version"],
                    "date" => strtotime((string) $version["date"]),
                    "usr_id" => "il_" . IL_INST_ID . "_usr_" . $version["user_id"],
                    "action" => $version["action"],
                    "rollback_version" => $version["rollback_version"],
                    "rollback_user_id" => $version["rollback_user_id"]
                ];

                $content = "";

                if ($this->attachFileContents !== 0) {
                    $filename = $this->file->getFile($version["version"]);

                    if (@is_file($filename)) {
                        if ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_COPY) {
                            $attribs ["mode"] = "COPY";
                            $content = "/" . $version["version"] . "_" . $this->file->getFileName();
                            copy($filename, $this->target_dir_absolute . $content);
                            $content = $this->target_dir_relative . $content;
                        } // begin-patch fm
                        elseif ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_REST) {
                            $attribs ['mode'] = "REST";
                            $fs = new ilRestFileStorage();
                            $content = $fs->storeFileForRest(base64_encode(@file_get_contents($filename)));
                            ;
                        } // end-patch fm
                        else {
                            $content = @file_get_contents($filename);
                            $attribs ["mode"] = "PLAIN";
                            if ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED) {
                                $attribs ["mode"] = "ZLIB";
                                $content = @gzcompress($content, 9);
                            } elseif ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED) {
                                $attribs ["mode"] = "GZIP";
                                $content = @gzencode($content, 9);
                            }
                            $content = base64_encode($content);
                        }
                    }
                }

                $this->xmlElement("Version", $attribs, $content);
            }
            $this->xmlEndTag("Versions");
        }

        $this->xmlEndTag("File");

        $this->__buildFooter();

        return true;
    }

    public function getXML(): string
    {
        return $this->xmlDumpMem(false);
    }

    public function __buildHeader(): bool
    {
        if (!$this->getOmitHeader()) {
            $this->xmlSetDtdDef(
                "<!DOCTYPE File PUBLIC \"-//ILIAS//DTD FileAdministration//EN\" \"" . ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/ilias_file_3_8.dtd\">"
            );
            $this->xmlSetGenCmt("Exercise Object");
            $this->xmlHeader();
        }

        return true;
    }

    public function __buildFooter(): void
    {
    }
}