Inheritance diagram for ilFileXMLParser:

Collaboration diagram for ilFileXMLParser:

Public Member Functions
	__construct (public ilObjFile $file, string $a_xml_data, public int $obj_id=-1, public int $mode=0)
	Constructor. More...

	setImportDirectory (?string $a_val)
	Set import directory. More...

	getImportDirectory ()
	Get import directory. More...

	setHandlers ($a_xml_parser)
	set event handlers More...

	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	handler for begin of element More...

	handlerEndTag ($a_xml_parser, string $a_name)
	handler for end of element More...

	handlerCharacterData ($a_xml_parser, string $a_data)
	handler for character data More...

	setFileContents ()
	update file according to filename and version, does not update history has to be called after (!) file save for new objects, since file storage will be initialised with obj id. More...

	updateFileContents ()
	update file according to filename and version and create history entry has to be called after (!) file save for new objects, since file storage will be initialised with obj id. More...

	start ()
	starts parsing an changes object by side effect. More...

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Static Public Member Functions
static	normalizeRelativePath (string $path)
	Normalize relative directories in a path. More...

Data Fields
bool	$result = false
	result of parsing and updating More...

string	$tmpFilename = null
	file of temporary file where we store the file content instead of in memory More...

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Static Public Attributes
static int	$CONTENT_NOT_COMPRESSED = 0

static int	$CONTENT_GZ_COMPRESSED = 1

static int	$CONTENT_ZLIB_COMPRESSED = 2

static int	$CONTENT_COPY = 4

static int	$CONTENT_REST = 5

Protected Attributes
int	$version = null

string	$action = null

int	$max_version = null

int	$date = null

int	$usr_id = null

array	$versions = []

string	$import_directory = null

string	$cdata = null

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Member Functions
	fastBase64Decode (string $filein, string $fileout)

	fastGunzip (string $in, string $out)

Additional Inherited Members
Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Detailed Description

Definition at line 32 of file class.ilFileXMLParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileXMLParser::__construct	(	public ilObjFile	$file,
		string	$a_xml_data,
		public int	$obj_id = `-1`,
		public int	$mode = `0`
	)

Constructor.

Parameters

$file	Exercise object which has been parsed
$obj_id	this will be matched against the id in the xml in case we want to update an exercise
$mode	Content compression mode, defaults to no compression

Definition at line 61 of file class.ilFileXMLParser.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct(), and ilSaxParser\setXMLContent().

       {
         parent::__construct();
         $this->setXMLContent($a_xml_data);
     }

Here is the call graph for this function:

Member Function Documentation

◆ fastBase64Decode()

ilFileXMLParser::fastBase64Decode	(	string	$filein,
		string	$fileout
	)

private

Definition at line 431 of file class.ilFileXMLParser.php.

Referenced by handlerEndTag().

                                                                       : bool
     {
         $fh = fopen($filein, 'rb');
         $fh2 = fopen($fileout, 'wb');
         stream_filter_append($fh2, 'convert.base64-decode');
 
         while (!feof($fh)) {
             $chunk = fgets($fh);
             if ($chunk === false) {
                 break;
             }
             fwrite($fh2, $chunk);
         }
         fclose($fh);
         fclose($fh2);
 
         return true;
     }

Here is the caller graph for this function:

◆ fastGunzip()

ilFileXMLParser::fastGunzip	(	string	$in,
		string	$out
	)

private

Definition at line 450 of file class.ilFileXMLParser.php.

Referenced by handlerEndTag().

                                                         : bool
     {
         if (!file_exists($in)) {
             return false;
         }
         if (!is_readable($in)) {
             return false;
         }
         if (!file_exists($out) && !is_writable(dirname($out))) {
             return false;
         }
         if (file_exists($out) && !is_writable($out)) {
             return false;
         }
         $in_file = gzopen($in, "rb");
         $out_file = fopen($out, "wb");
 
         while (!gzeof($in_file)) {
             $buffer = gzread($in_file, 4096);
             fwrite($out_file, $buffer, 4096);
         }
 
         gzclose($in_file);
         fclose($out_file);
 
         return true;
     }

Here is the caller graph for this function:

◆ getImportDirectory()

ilFileXMLParser::getImportDirectory ( )

Get import directory.

Returns: mixed|null import directory

Definition at line 96 of file class.ilFileXMLParser.php.

References $import_directory.

Referenced by handlerEndTag().

                                         : ?string
     {
         return $this->import_directory;
     }

Here is the caller graph for this function:

◆ handlerBeginTag()

ilFileXMLParser::handlerBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

handler for begin of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name
array	$a_attribs	element attributes array

Exceptions

ilFileException when obj id != - 1 and if it it does not match the id in the xml or deflation mode is not supported

Definition at line 125 of file class.ilFileXMLParser.php.

References $CONTENT_COPY, $CONTENT_GZ_COMPRESSED, $CONTENT_NOT_COMPRESSED, $CONTENT_REST, $CONTENT_ZLIB_COMPRESSED, $date, $DIC, ilFileException\$ID_DEFLATE_METHOD_MISMATCH, ilFileException\$ID_MISMATCH, $usr_id, ilUtil\__extractId(), IL_INST_ID, and ILIAS\Repository\int().

                                                                                     : void
     {
         global $DIC;
 
         global $DIC;
 
         switch ($a_name) {
             case 'File':
                 if (isset($a_attribs["obj_id"])) {
                     $read_obj_id = ilUtil::__extractId($a_attribs["obj_id"], IL_INST_ID);
                     if ($this->obj_id != -1 && (int) $read_obj_id != -1 && $this->obj_id != (int) $read_obj_id) {
                         throw new ilFileException(
                             "Object IDs (xml $read_obj_id and argument " . $this->obj_id . ") do not match!",
                             ilFileException::$ID_MISMATCH
                         );
                     }
                 }
 
                 break;
             case 'Content': // Old import files
             case 'Version':
                 if ($a_name === "Version" && !isset($a_attribs["mode"])) {
                     // Old import files
                     $this->version = null;
                     if ($this->date === null) {
                         // Version tag comes after Content tag. Take only first (= Should be latest)
                         $this->date = $a_attribs["date"];
                         $this->usr_id = (int) $a_attribs["usr_id"];
                         $this->versions[0]["date"] = $this->date;
                         $this->versions[0]["usr_id"] = $this->usr_id;
                     }
                     break;
                 }
 
                 $this->mode = ilFileXMLParser::$CONTENT_NOT_COMPRESSED;
                 #echo $a_attribs["mode"];
                 if (isset($a_attribs["mode"])) {
                     if ($a_attribs["mode"] == "GZIP") {
                         if (!function_exists("gzread")) {
                             throw new ilFileException(
                                 "Deflating with gzip is not supported",
                                 ilFileException::$ID_DEFLATE_METHOD_MISMATCH
                             );
                         }
 
                         $this->mode = ilFileXMLParser::$CONTENT_GZ_COMPRESSED;
                     } elseif ($a_attribs["mode"] == "ZLIB") {
                         if (!function_exists("gzuncompress")) {
                             throw new ilFileException(
                                 "Deflating with zlib (compress/uncompress) is not supported",
                                 ilFileException::$ID_DEFLATE_METHOD_MISMATCH
                             );
                         }
 
                         $this->mode = ilFileXMLParser::$CONTENT_ZLIB_COMPRESSED;
                     } elseif ($a_attribs["mode"] == "COPY") {
                         $this->mode = ilFileXMLParser::$CONTENT_COPY;
                     } // begin-patch fm
                     elseif ($a_attribs['mode'] == 'REST') {
                         $this->mode = ilFileXMLParser::$CONTENT_REST;
                     }
                     // end-patch fm
                 }
 
                 if ($a_name === "Version") {
                     $this->version = (int) $a_attribs["version"];
                     $this->max_version = (int) $a_attribs["max_version"];
                     $this->date = (int) $a_attribs["date"];
                     $this->usr_id = (int) $a_attribs["usr_id"];
                     $this->action = (string) $a_attribs["action"];
                 }
         }
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilFileXMLParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

Definition at line 315 of file class.ilFileXMLParser.php.

References $CONTENT_COPY, and $CONTENT_REST.

                                                                        : void
     {
         if ($a_data != "\n") {
             // begin-patch fm
             if ($this->mode !== ilFileXMLParser::$CONTENT_COPY
                 && $this->mode !== ilFileXMLParser::$CONTENT_REST
             ) { // begin-patch fm
                 $this->cdata .= $a_data;
             } else {
                 $this->cdata .= $a_data;
             }
         }
     }

◆ handlerEndTag()

ilFileXMLParser::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

Definition at line 205 of file class.ilFileXMLParser.php.

References $action, $CONTENT_COPY, $CONTENT_GZ_COMPRESSED, $CONTENT_REST, $CONTENT_ZLIB_COMPRESSED, $date, ilFileException\$DECOMPRESSION_FAILED, $DIC, $GLOBALS, $max_version, $tmpFilename, $usr_id, $version, fastBase64Decode(), fastGunzip(), getImportDirectory(), and ilFileUtils\ilTempnam().

                                                                 : void
     {
         $this->cdata = trim($this->cdata ?? '');
 
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': ' . $this->cdata);
 
         switch ($a_name) {
             case 'File':
                 $this->result = true;
                 break;
             case 'Filename':
                 if ($this->cdata === '') {
                     throw new ilFileException("Filename ist missing!");
                 }
 
                 $this->file->setFilename($this->cdata);
                 $this->file->setTitle($this->cdata);
 
                 break;
             case 'Title':
                 $this->file->setTitle(trim($this->cdata));
                 break;
             case 'Description':
                 $this->file->setDescription(trim($this->cdata));
                 break;
             case 'Rating':
                 $this->file->setRating((bool) $this->cdata);
                 break;
             case 'Content': // Old import files
             case 'Version':
                 if ($a_name === "Version" && $this->version === null) {
                     // Old import files
                     break;
                 }
 
                 $baseDecodedFilename = ilFileUtils::ilTempnam();
                 if ($this->mode === ilFileXMLParser::$CONTENT_COPY) {
                     $this->tmpFilename = $this->getImportDirectory() . "/" . self::normalizeRelativePath($this->cdata);
                 } // begin-patch fm
                 elseif ($this->mode === ilFileXMLParser::$CONTENT_REST) {
                     $storage = new ilRestFileStorage();
                     $this->tmpFilename = $storage->getStoredFilePath(self::normalizeRelativePath($this->cdata));
                     if (!$this->fastBase64Decode($this->tmpFilename, $baseDecodedFilename)) {
                         throw new ilFileException("Base64-Decoding failed", ilFileException::$DECOMPRESSION_FAILED);
                     }
                     $this->tmpFilename = $baseDecodedFilename;
                 } // end-patch fm
                 else {
                     if (!$this->fastBase64Decode($this->tmpFilename, $baseDecodedFilename)) {
                         throw new ilFileException("Base64-Decoding failed", ilFileException::$DECOMPRESSION_FAILED);
                     }
                     if ($this->mode === ilFileXMLParser::$CONTENT_GZ_COMPRESSED) {
                         if (!$this->fastGunzip($baseDecodedFilename, $this->tmpFilename)) {
                             throw new ilFileException(
                                 "Deflating with fastzunzip failed",
                                 ilFileException::$DECOMPRESSION_FAILED
                             );
                         }
                         unlink($baseDecodedFilename);
                     } elseif ($this->mode === ilFileXMLParser::$CONTENT_ZLIB_COMPRESSED) {
                         if (!$this->fastGunzip($baseDecodedFilename, $this->tmpFilename)) {
                             throw new ilFileException(
                                 "Deflating with fastDecompress failed",
                                 ilFileException::$DECOMPRESSION_FAILED
                             );
                         }
                         unlink($baseDecodedFilename);
                     } else {
                         $this->tmpFilename = $baseDecodedFilename;
                     }
                 }
 
                 //$this->content = $content;
                 // see #17211
 
                 if ($this->version == $this->file->getVersion()) {
                     if (is_file($this->tmpFilename)) {
                         $this->file->setFileSize(filesize($this->tmpFilename)); // strlen($this->content));
                     }
 
                     // if no file type is given => lookup mime type
                     if (!$this->file->getFileType()) {
                         global $DIC;
                         $this->file->setFileType(MimeType::getMimeType($this->tmpFilename));
                     }
                 }
 
                 $this->versions[] = [
                     "version" => $this->version,
                     "max_version" => $this->max_version,
                     "tmpFilename" => $this->tmpFilename,
                     "date" => $this->date,
                     "usr_id" => $this->usr_id,
                     "action" => $this->action,
                 ];
                 $this->version = null;
                 $this->date = null;
                 $this->usr_id = null;
                 break;
         }
 
         $this->cdata = '';
     }

Here is the call graph for this function:

◆ normalizeRelativePath()

static ilFileXMLParser::normalizeRelativePath ( string $path )

static

Normalize relative directories in a path.

Source: https://github.com/thephpleague/flysystem/blob/master/src/Util.php#L96 Workaround until we have

Exceptions

LogicException

Definition at line 405 of file class.ilFileXMLParser.php.

References $parts.

                                                               : string
     {
         $path = str_replace('\\', '/', $path);
 
         while (preg_match('#\p{C}+|^\./#u', $path)) {
             $path = preg_replace('#\p{C}+|^\./#u', '', $path);
         }
 
         $parts = [];
         foreach (explode('/', $path) as $part) {
             switch ($part) {
                 case '':
                 case '.':
                     break;
                 case '..':
                     array_pop($parts);
                     break;
                 default:
                     $parts[] = $part;
                     break;
             }
         }
 
         return implode('/', $parts);
     }

◆ setFileContents()

ilFileXMLParser::setFileContents ( )

update file according to filename and version, does not update history has to be called after (!) file save for new objects, since file storage will be initialised with obj id.

Definition at line 334 of file class.ilFileXMLParser.php.

References ilHistory\_removeEntriesForObject(), and ilLoggerFactory\getLogger().

                                      : void
     {
         // Delete exists version 1 history
         ilHistory::_removeEntriesForObject($this->file->getId());
 
         foreach ($this->versions as $version) {
             if (!file_exists($version["tmpFilename"])) {
                 if (!isset($version["tmpFilename"])) {
                     continue;
                 }
                 // try to get first file of directory
                 $files = scandir(dirname($version["tmpFilename"]));
                 $version["tmpFilename"] = rtrim(
                     dirname($version["tmpFilename"]),
                     "/"
                 ) . "/" . $files[2];// because [0] = "." [1] = ".."
                 if (!file_exists($version["tmpFilename"])) {
                     ilLoggerFactory::getLogger('file')->error(
                         __METHOD__ . ' "' . ($version["tmpFilename"]) . '" file not found.'
                     );
 
                     continue;
                 }
             }
 
             if (filesize($version["tmpFilename"]) == 0) {
                 continue;
             }
 
             // imported file version
             $import_file_version_path = $version["tmpFilename"];
 
             $stream = Streams::ofResource(fopen($import_file_version_path, 'rb'));
             $this->file->appendStream($stream, $this->file->getTitle());
         }
     }

Here is the call graph for this function:

◆ setHandlers()

ilFileXMLParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser

private

Definition at line 108 of file class.ilFileXMLParser.php.

                                               : void
     {
         xml_set_object($a_xml_parser, $this);
         xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
         xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
     }

◆ setImportDirectory()

ilFileXMLParser::setImportDirectory ( ?string $a_val )

Set import directory.

Parameters

string import directory

Definition at line 86 of file class.ilFileXMLParser.php.

                                                       : void
     {
         $this->import_directory = $a_val;
     }

◆ start()

ilFileXMLParser::start ( )

starts parsing an changes object by side effect.

Returns: boolean true, if no errors happend.

Exceptions

ilFileException when obj id != - 1 and if it it does not match the id in the xml

Definition at line 388 of file class.ilFileXMLParser.php.

References ilSaxParser\startParsing().

                            : bool
     {
         $this->startParsing();
 
         return $this->result > 0;
     }

Here is the call graph for this function:

◆ updateFileContents()

ilFileXMLParser::updateFileContents ( )

update file according to filename and version and create history entry has to be called after (!) file save for new objects, since file storage will be initialised with obj id.

Definition at line 376 of file class.ilFileXMLParser.php.

Field Documentation

◆ $action

string ilFileXMLParser::$action = null

protected

Definition at line 50 of file class.ilFileXMLParser.php.

Referenced by handlerEndTag().

◆ $cdata

string ilFileXMLParser::$cdata = null

protected

Definition at line 56 of file class.ilFileXMLParser.php.

◆ $CONTENT_COPY

int ilFileXMLParser::$CONTENT_COPY = 4

static

Definition at line 37 of file class.ilFileXMLParser.php.

Referenced by handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

◆ $CONTENT_GZ_COMPRESSED

int ilFileXMLParser::$CONTENT_GZ_COMPRESSED = 1

static

Definition at line 35 of file class.ilFileXMLParser.php.

Referenced by handlerBeginTag(), and handlerEndTag().

◆ $CONTENT_NOT_COMPRESSED

int ilFileXMLParser::$CONTENT_NOT_COMPRESSED = 0

static

Definition at line 34 of file class.ilFileXMLParser.php.

Referenced by handlerBeginTag().

◆ $CONTENT_REST

int ilFileXMLParser::$CONTENT_REST = 5

static

Definition at line 39 of file class.ilFileXMLParser.php.

Referenced by handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

◆ $CONTENT_ZLIB_COMPRESSED

int ilFileXMLParser::$CONTENT_ZLIB_COMPRESSED = 2

static

Definition at line 36 of file class.ilFileXMLParser.php.

Referenced by handlerBeginTag(), and handlerEndTag().

◆ $date

int ilFileXMLParser::$date = null

protected

Definition at line 52 of file class.ilFileXMLParser.php.

Referenced by handlerBeginTag(), and handlerEndTag().

◆ $import_directory

string ilFileXMLParser::$import_directory = null

protected

Definition at line 55 of file class.ilFileXMLParser.php.

Referenced by getImportDirectory().

◆ $max_version

int ilFileXMLParser::$max_version = null

protected

Definition at line 51 of file class.ilFileXMLParser.php.

Referenced by handlerEndTag().

◆ $result

bool ilFileXMLParser::$result = false

result of parsing and updating

Definition at line 43 of file class.ilFileXMLParser.php.

◆ $tmpFilename

string ilFileXMLParser::$tmpFilename = null

file of temporary file where we store the file content instead of in memory

Definition at line 47 of file class.ilFileXMLParser.php.

Referenced by handlerEndTag().

◆ $usr_id

int ilFileXMLParser::$usr_id = null

protected

Definition at line 53 of file class.ilFileXMLParser.php.

Referenced by handlerBeginTag(), and handlerEndTag().

◆ $version

int ilFileXMLParser::$version = null

protected

Definition at line 49 of file class.ilFileXMLParser.php.

Referenced by handlerEndTag().

◆ $versions

array ilFileXMLParser::$versions = []

protected

Definition at line 54 of file class.ilFileXMLParser.php.

The documentation for this class was generated from the following file:

Modules/File/classes/class.ilFileXMLParser.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fastBase64Decode()

◆ fastGunzip()

◆ getImportDirectory()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ normalizeRelativePath()

◆ setFileContents()

◆ setHandlers()

◆ setImportDirectory()

◆ start()

◆ updateFileContents()

Field Documentation

◆ $action

◆ $cdata

◆ $CONTENT_COPY

◆ $CONTENT_GZ_COMPRESSED

◆ $CONTENT_NOT_COMPRESSED

◆ $CONTENT_REST

◆ $CONTENT_ZLIB_COMPRESSED

◆ $date

◆ $import_directory

◆ $max_version

◆ $result

◆ $tmpFilename

◆ $usr_id

◆ $version

◆ $versions