Exercise XML Parser which completes/updates a given file by an xml string. More...

Inheritance diagram for ilFileXMLParser:

Collaboration diagram for ilFileXMLParser:

Public Member Functions
	__construct (&$file, $a_xml_data, $obj_id=-1, $mode=0)
	Constructor. More...

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

	getImportDirectory ()
	Get import directory. More...

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

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

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

	handlerCharacterData ($a_xml_parser, $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 ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object public. More...

	setXMLContent ($a_xml_content)

	getXMLContent ()

	getInputType ()

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

	createParser ()
	create parser More...

	setOptions ($a_xml_parser)
	set parser options More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...

	openXMLFile ()
	open xml file More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	freeParser ($a_xml_parser)
	free xml parser handle More...

	setThrowException ($throwException)
	set error handling More...

Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

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

Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Data Fields
	$file

	$obj_id

	$result

	$mode

	$tmpFilename

Data Fields inherited from ilSaxParser
	$input_type = null

	$xml_content = ''

	$ilias

	$lng

	$xml_file

	$throwException = false

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Static Public Attributes
static	$CONTENT_NOT_COMPRESSED = 0

static	$CONTENT_GZ_COMPRESSED = 1

static	$CONTENT_ZLIB_COMPRESSED = 2

static	$CONTENT_COPY = 4

static	$CONTENT_REST = 5

Additional Inherited Members
Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Detailed Description

Exercise XML Parser which completes/updates a given file by an xml string.

Author: Roland Küstermann rolan.nosp@m.d@ku.nosp@m.ester.nosp@m.mann.nosp@m..com

Version

Id: class.ilObjectXMLParser.php 12811 2006-12-08 18:37:44Z akill

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

Constructor & Destructor Documentation

◆ __construct()

ilFileXMLParser::__construct	(	&	$file,
			$a_xml_data,
			$obj_id = `-1`,
			$mode = `0`
	)

Constructor.

Parameters

ilObjFile	$file	existing file object
string	$a_xml_file	xml data
int	$obj_id	obj id of exercise which is to be updated

public

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

References $file, $mode, $obj_id, file, and ilSaxParser\setXMLContent().

     {
         parent::__construct();
         $this->file = $file;
         $this->setXMLContent($a_xml_data);
         $this->obj_id = $obj_id;
         $this->result = false;
         $this->mode = $mode;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getImportDirectory()

ilFileXMLParser::getImportDirectory ( )

Get import directory.

Returns: string import directory

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

Referenced by handlerEndTag().

     {
         return $this->importDirectory;
     }

Here is the caller graph for this function:

◆ handlerBeginTag()

ilFileXMLParser::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$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 136 of file class.ilFileXMLParser.php.

References $CONTENT_COPY, $CONTENT_GZ_COMPRESSED, $CONTENT_NOT_COMPRESSED, $CONTENT_REST, $CONTENT_ZLIB_COMPRESSED, $DIC, ilFileException\$ID_DEFLATE_METHOD_MISMATCH, ilFileException\$ID_MISMATCH, $ilErr, $ilLog, ilUtil\__extractId(), file, and ilUtil\ilTempnam().

     {
         global $DIC;
         $ilErr = $DIC['ilErr'];
 
         global $DIC;
         $ilLog = $DIC['ilLog'];
 
         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 && (int) $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);
                     }
                 }
                 if (isset($a_attribs["type"])) {
                     $this->file->setFileType($a_attribs["type"]);
                 }
                 $this->file->setVersion($this->file->getVersion() + 1);
                 break;
             case 'Content':
                 $this->tmpFilename = ilUtil::ilTempnam();
                 $this->mode = ilFileXMLParser::$CONTENT_NOT_COMPRESSED;
                 $this->isReadingFile = true;
                 #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
                 }
         }
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilFileXMLParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

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

References $CONTENT_COPY, and $CONTENT_REST.

     {
         if ($a_data != "\n") {
             // begin-patch fm
             if ($this->isReadingFile && $this->mode != ilFileXMLParser::$CONTENT_COPY && $this->mode != ilFileXMLParser::$CONTENT_REST) { // begin-patch fm
                 $handle = fopen($this->tmpFilename, "a");
                 fwrite($handle, $a_data);
                 fclose($handle);
             } else {
                 $this->cdata .= $a_data;
             }
         }
     }

◆ handlerEndTag()

ilFileXMLParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

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

References $CONTENT_COPY, $CONTENT_GZ_COMPRESSED, $CONTENT_REST, $CONTENT_ZLIB_COMPRESSED, ilFileException\$DECOMPRESSION_FAILED, $DIC, $GLOBALS, $ilLog, ilFileUtils\_lookupMimeType(), ilFileUtils\fastBase64Decode(), ilFileUtils\fastGunzip(), file, getImportDirectory(), and ilUtil\ilTempnam().

     {
         $this->cdata = trim($this->cdata);
 
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': ' . $this->cdata);
 
         switch ($a_name) {
             case 'File':
                 $this->result = true;
                 break;
             case 'Filename':
                 if (strlen($this->cdata) == 0) {
                     throw new ilFileException("Filename ist missing!");
                 }
 
                 $this->file->setFilename(basename(self::normalizeRelativePath($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':
                 $GLOBALS['DIC']['ilLog']->write($this->mode);
                 $this->isReadingFile = false;
                 $baseDecodedFilename = ilUtil::ilTempnam();
                 if ($this->mode == ilFileXMLParser::$CONTENT_COPY) {
                     $this->tmpFilename = $this->getImportDirectory() . "/" . self::normalizeRelativePath($this->cdata);
                 } // begin-patch fm
                 elseif ($this->mode == ilFileXMLParser::$CONTENT_REST) {
                     include_once './Services/WebServices/Rest/classes/class.ilRestFileStorage.php';
                     $storage = new ilRestFileStorage();
                     $this->tmpFilename = $storage->getStoredFilePath(self::normalizeRelativePath($this->cdata));
                     if (!ilFileUtils::fastBase64Decode($this->tmpFilename, $baseDecodedFilename)) {
                         throw new ilFileException("Base64-Decoding failed", ilFileException::$DECOMPRESSION_FAILED);
                     }
                     $this->tmpFilename = $baseDecodedFilename;
                 } // end-patch fm
                 else {
                     if (!ilFileUtils::fastBase64Decode($this->tmpFilename, $baseDecodedFilename)) {
                         throw new ilFileException("Base64-Decoding failed", ilFileException::$DECOMPRESSION_FAILED);
                     }
                     if ($this->mode == ilFileXMLParser::$CONTENT_GZ_COMPRESSED) {
                         if (!ilFileUtils::fastGunzip($baseDecodedFilename, $this->tmpFilename)) {
                             throw new ilFileException("Deflating with fastzunzip failed", ilFileException::$DECOMPRESSION_FAILED);
                         }
                         unlink($baseDecodedFilename);
                     } elseif ($this->mode == ilFileXMLParser::$CONTENT_ZLIB_COMPRESSED) {
                         if (!ilFileUtils::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 (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;
                     $ilLog = $DIC['ilLog'];
 
                     #$ilLog->write(__METHOD__.': Trying to detect mime type...');
                     include_once('./Services/Utilities/classes/class.ilFileUtils.php');
                     $this->file->setFileType(ilFileUtils::_lookupMimeType($this->tmpFilename));
                 }
 
                 break;
         }
 
         $this->cdata = '';
 
         return;
     }

Here is the call graph for this function:

◆ normalizeRelativePath()

static ilFileXMLParser::normalizeRelativePath ( $path )

static

Normalize relative directories in a path.

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

Parameters

string $path

Returns: string

Exceptions

LogicException

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

References $path.

     {
         $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 306 of file class.ilFileXMLParser.php.

References $filename, file, ilLoggerFactory\getLogger(), ilUtil\makeDir(), and ilFileUtils\rename().

Referenced by updateFileContents().

     {
         if (!file_exists($this->tmpFilename)) {
             ilLoggerFactory::getLogger('file')->error(__METHOD__ . ' "' . $this->tmpFilename . '" file not found.');
 
             return;
         }
 
         if (filesize($this->tmpFilename) == 0) {
             return;
         }
 
         $filedir = $this->file->getDirectory($this->file->getVersion());
 
         if (!is_dir($filedir)) {
             $this->file->createDirectory();
             ilUtil::makeDir($filedir);
         }
 
         $filename = $filedir . "/" . $this->file->getFileName();
 
         if (file_exists($filename)) {
             unlink($filename);
         }
 
         return ilFileUtils::rename($this->tmpFilename, $filename);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilFileXMLParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser

private

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

     {
         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 ( $a_val )

Set import directory.

Parameters

string import directory

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

     {
         $this->importDirectory = $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 357 of file class.ilFileXMLParser.php.

References ilSaxParser\startParsing().

     {
         $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 340 of file class.ilFileXMLParser.php.

References ilHistory\_createEntry(), file, and setFileContents().

     {
         if ($this->setFileContents()) {
             require_once("./Services/History/classes/class.ilHistory.php");
             ilHistory::_createEntry($this->file->getId(), "replace", $this->file->getFilename() . "," . $this->file->getVersion());
             $this->file->addNewsNotification("file_updated");
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $CONTENT_COPY

ilFileXMLParser::$CONTENT_COPY = 4

static

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

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

◆ $CONTENT_GZ_COMPRESSED

ilFileXMLParser::$CONTENT_GZ_COMPRESSED = 1

static

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

Referenced by handlerBeginTag(), and handlerEndTag().

◆ $CONTENT_NOT_COMPRESSED

ilFileXMLParser::$CONTENT_NOT_COMPRESSED = 0

static

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

Referenced by handlerBeginTag().

◆ $CONTENT_REST

ilFileXMLParser::$CONTENT_REST = 5

static

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

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

◆ $CONTENT_ZLIB_COMPRESSED

ilFileXMLParser::$CONTENT_ZLIB_COMPRESSED = 2

static

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

Referenced by handlerBeginTag(), and handlerEndTag().

◆ $file

ilFileXMLParser::$file

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

Referenced by __construct().

◆ $mode

ilFileXMLParser::$mode

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

Referenced by __construct().

◆ $obj_id

ilFileXMLParser::$obj_id

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

Referenced by __construct().

◆ $result

ilFileXMLParser::$result

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

◆ $tmpFilename

ilFileXMLParser::$tmpFilename

Definition at line 66 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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getImportDirectory()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ normalizeRelativePath()

◆ setFileContents()

◆ setHandlers()

◆ setImportDirectory()

◆ start()

◆ updateFileContents()

Field Documentation

◆ $CONTENT_COPY

◆ $CONTENT_GZ_COMPRESSED

◆ $CONTENT_NOT_COMPRESSED

◆ $CONTENT_REST

◆ $CONTENT_ZLIB_COMPRESSED

◆ $file

◆ $mode

◆ $obj_id

◆ $result

◆ $tmpFilename