ilQtiMatImageSecurity Class Reference

Collaboration diagram for ilQtiMatImageSecurity:

Public Member Functions
	__construct (protected ilQTIMatimage $image_material, private QuestionFiles $question_files)
	getImageMaterial ()
	setImageMaterial (ilQTIMatimage $image_material)
	validate ()
	sanitizeLabel ()

Protected Member Functions
	getDetectedMimeType ()
	setDetectedMimeType (string $detectedMimeType)
	validateContent ()
	validateLabel ()
	determineMimeType (?string $content)
	determineFileExtension (string $label)
	hasFileExtension (string $label)

Protected Attributes
string	$detectedMimeType = ""

Detailed Description

Definition at line 29 of file class.ilQtiMatImageSecurity.php.

Constructor & Destructor Documentation

__construct()

ilQtiMatImageSecurity::__construct	(	protected ilQTIMatimage	$image_material,
		private QuestionFiles	$question_files
	)

Definition at line 33 of file class.ilQtiMatImageSecurity.php.

      {
        if (!strlen($this->getImageMaterial()->getRawContent())) {
            throw new ilQtiException('cannot import image without content');
        }
 
        $this->setDetectedMimeType(
            $this->determineMimeType($this->getImageMaterial()->getRawContent())
        );
    }

References determineMimeType(), getImageMaterial(), and setDetectedMimeType().

Here is the call graph for this function:

Member Function Documentation

determineFileExtension()

ilQtiMatImageSecurity::determineFileExtension ( string  $label )

protected

Definition at line 142 of file class.ilQtiMatImageSecurity.php.

                                                            : ?string
    {
        $pathInfo = pathinfo($label);
 
        if (isset($pathInfo['extension'])) {
            return $pathInfo['extension'];
        }
 
        return null;
    }

Referenced by validateLabel().

Here is the caller graph for this function:

determineMimeType()

ilQtiMatImageSecurity::determineMimeType ( ?string  $content )

protected

Definition at line 135 of file class.ilQtiMatImageSecurity.php.

                                                          : string
    {
        $finfo = new finfo(FILEINFO_MIME);
 
        return $finfo->buffer($content);
    }

Referenced by __construct().

Here is the caller graph for this function:

getDetectedMimeType()

ilQtiMatImageSecurity::getDetectedMimeType ( )

protected

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

                                            : string
    {
        return $this->detectedMimeType;
    }

References $detectedMimeType.

Referenced by validateContent(), and validateLabel().

Here is the caller graph for this function:

getImageMaterial()

ilQtiMatImageSecurity::getImageMaterial

(

)

Definition at line 46 of file class.ilQtiMatImageSecurity.php.

                                      : ilQTIMatimage
    {
        return $this->image_material;
    }

Referenced by __construct(), sanitizeLabel(), validateContent(), and validateLabel().

Here is the caller graph for this function:

hasFileExtension()

ilQtiMatImageSecurity::hasFileExtension ( string  $label )

protected

Definition at line 153 of file class.ilQtiMatImageSecurity.php.

                                                      : bool
    {
        $pathInfo = pathinfo($label);
 
        return array_key_exists('extension', $pathInfo);
    }

Referenced by validateLabel().

Here is the caller graph for this function:

sanitizeLabel()

ilQtiMatImageSecurity::sanitizeLabel

(

)

Definition at line 124 of file class.ilQtiMatImageSecurity.php.

                                   : void
    {
        $label = $this->getImageMaterial()->getLabel();
 
        $label = basename($label);
        $label = ilUtil::stripSlashes($label);
        $label = ilFileUtils::getASCIIFilename($label);
 
        $this->getImageMaterial()->setLabel($label);
    }

References ilFileUtils\getASCIIFilename(), getImageMaterial(), and ilUtil\stripSlashes().

Here is the call graph for this function:

setDetectedMimeType()

ilQtiMatImageSecurity::setDetectedMimeType ( string  $detectedMimeType )

protected

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

                                                                    : void
    {
        $this->detectedMimeType = $detectedMimeType;
    }

References $detectedMimeType.

Referenced by __construct().

Here is the caller graph for this function:

setImageMaterial()

ilQtiMatImageSecurity::setImageMaterial

(

ilQTIMatimage

$image_material

)

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

                                                                   : void
    {
        $this->image_material = $image_material;
    }

validate()

ilQtiMatImageSecurity::validate

(

)

Definition at line 66 of file class.ilQtiMatImageSecurity.php.

                              : bool
    {
        if (!$this->validateLabel()) {
            return false;
        }
 
        if (!$this->validateContent()) {
            return false;
        }
 
        return true;
    }

References validateContent(), and validateLabel().

Here is the call graph for this function:

validateContent()

ilQtiMatImageSecurity::validateContent ( )

protected

Definition at line 79 of file class.ilQtiMatImageSecurity.php.

                                        : bool
    {
        if ($this->getImageMaterial()->getImagetype() && !$this->question_files->isAllowedImageMimeType($this->getImageMaterial()->getImagetype())) {
            return false;
        }
 
        if (!$this->question_files->isAllowedImageMimeType($this->getDetectedMimeType())) {
            return false;
        }
 
        if ($this->getImageMaterial()->getImagetype()) {
            $declaredMimeType = current(explode(';', $this->getImageMaterial()->getImagetype()));
            $detectedMimeType = current(explode(';', $this->getDetectedMimeType()));
 
            if ($declaredMimeType != $detectedMimeType) {
                // since ilias exports jpeg declared pngs itself, we skip this validation ^^
                // return false;
 
                /* @var ilComponentLogger $log */
                $log = $GLOBALS['DIC'] ? $GLOBALS['DIC']['ilLog'] : $GLOBALS['ilLog'];
                $log->log(
                    'QPL: imported image with declared mime (' . $declaredMimeType . ') '
                    . 'and detected mime (' . $detectedMimeType . ')'
                );
            }
        }
 
        return true;
    }

References $detectedMimeType, $GLOBALS, $log, getDetectedMimeType(), and getImageMaterial().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

validateLabel()

ilQtiMatImageSecurity::validateLabel ( )

protected

Definition at line 109 of file class.ilQtiMatImageSecurity.php.

                                      : bool
    {
        if ($this->getImageMaterial()->getUri()) {
            if (!$this->hasFileExtension($this->getImageMaterial()->getUri())) {
                return true;
            }
 
            $extension = $this->determineFileExtension($this->getImageMaterial()->getUri());
        } else {
            $extension = $this->determineFileExtension($this->getImageMaterial()->getLabel());
        }
 
        return $this->question_files->isAllowedImageFileExtension($this->getDetectedMimeType(), $extension);
    }

References determineFileExtension(), getDetectedMimeType(), getImageMaterial(), ILIAS\Test\Questions\Presentation\getLabel, and hasFileExtension().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$detectedMimeType

string ilQtiMatImageSecurity::$detectedMimeType = ""

protected

Definition at line 31 of file class.ilQtiMatImageSecurity.php.

Referenced by getDetectedMimeType(), setDetectedMimeType(), and validateContent().

---

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

• components/ILIAS/TestQuestionPool/classes/QTI/class.ilQtiMatImageSecurity.php