ilShellUtil Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilShellUtil:

Static Public Member Functions
static	resizeImage (string $a_from, string $a_to, int $a_width, int $a_height, bool $a_constrain_prop=false)
	resize image More...
static	escapeShellArg (string $a_arg)
static	escapeShellCmd (string $a_arg)
static	execQuoted (string $cmd, ?string $args=null)
static	isConvertVersionAtLeast (string $a_version)
	Compare convert version numbers. More...
static	getConvertCmd ()
	get convert command More...
static	convertImage (string $a_from, string $a_to, string $a_target_format="", string $a_geometry="", string $a_background_color="")
	convert image More...
static	execConvert (string $args)
	execute convert command More...

Static Protected Member Functions
static	processConvertVersion (string $a_version)
	Parse convert version string, e.g. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Util class various functions, usage as namespace

Author

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Deprecated:

The 2021 Technical Board has decided to mark the ilUtil class as deprecated. The ilUtil is a historically grown helper class with many different UseCases and functions. The class is not under direct maintainership and the responsibilities are unclear. In this context, the class should no longer be used in the code and existing uses should be converted to their own service in the medium term. If you need ilUtil for the implementation of a new function in ILIAS > 7, please contact the Technical Board.

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

Member Function Documentation

convertImage()

static ilShellUtil::convertImage ( string  $a_from, string  $a_to, string  $a_target_format = "", string  $a_geometry = "", string  $a_background_color = ""  )

static

convert image

Parameters

string	$a_from	source file
string	$a_to	target file
string	$a_target_format	target image file format

Definition at line 175 of file class.ilShellUtil.php.

References escapeShellArg(), and execConvert().

Referenced by ilCertificateUtilHelper\convertImage(), ilMediaItem\copyOriginal(), assSingleChoice\generateThumbForFile(), assMultipleChoice\generateThumbForFile(), assKprimChoice\generateThumbForFile(), assOrderingQuestion\generateThumbForFile(), assMatchingQuestion\generateThumbForFile(), assOrderingQuestionImport\handleUploadedFile(), ilObjMediaObject\makeThumbnail(), assMatchingQuestion\setImageFile(), assOrderingQuestion\storeImageFile(), assOrderingQuestion\updateImageFile(), ilObjCertificateSettings\uploadBackgroundImage(), and ilObjMediaObject\uploadVideoPreviewPic().

     : void {
        $format_str = ($a_target_format != "")
            ? strtoupper($a_target_format) . ":"
            : "";
        $geometry = "";
        if ($a_geometry != "") {
            if (is_int(strpos($a_geometry, "x"))) {
                $geometry = " -geometry " . $a_geometry . " ";
            } else {
                $geometry = " -geometry " . $a_geometry . "x" . $a_geometry . " ";
            }
        }

        $bg_color = ($a_background_color != "")
            ? " -background color " . $a_background_color . " "
            : "";
        $convert_cmd = ilShellUtil::escapeShellArg($a_from) . " " . $bg_color . $geometry . ilShellUtil::escapeShellArg(
            $format_str . $a_to
        );
        ilShellUtil::execConvert($convert_cmd);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

escapeShellArg()

static ilShellUtil::escapeShellArg ( string  $a_arg )

static

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

Referenced by convertImage(), ilPersonalProfileGUI\convertUserPicture(), ilPreviewRenderer\createPreviewImage(), ilExSubmission\downloadAllAssignmentFiles(), ilExSubmission\downloadMultipleFiles(), ilFFmpeg\extractImage(), ilWkhtmlToPdfConfig\getCheckboxCheckedSvgArgument(), ilWkhtmlToPdfConfig\getCheckboxSvgArgument(), ilWkhtmlToPdfConfig\getFooterArgument(), ilWkhtmlToPdfConfig\getHeaderArgument(), ilWkhtmlToPdfConfig\getMarginArgument(), ilWkhtmlToPdfConfig\getPageSizeArgument(), ilWkhtmlToPdfConfig\getRadioButtonCheckedSvgArgument(), ilWkhtmlToPdfConfig\getRadioButtonSvgArgument(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilGhostscriptRenderer\renderImages(), resizeImage(), ilVirusScannerAntiVir\scanFile(), ilVirusScannerSophos\scanFile(), ilVirusScannerICapClient\scanFile(), ilVirusScannerClamAV\scanFile(), ilFileUtils\unzip(), ilObjPortfolioBase\uploadImage(), ilObjBlog\uploadImage(), ilObjPoll\uploadImage(), ilObjUserGUI\uploadUserPictureObject(), ilObjMediaObject\uploadVideoPreviewPic(), and ilFileUtils\zip().

                                                        : string
    {
        setlocale(
            LC_CTYPE,
            "UTF8",
            "en_US.UTF-8"
        ); // fix for PHP escapeshellcmd bug. See: http://bugs.php.net/bug.php?id=45132
        // see also ilias bug 5630
        return escapeshellarg($a_arg);
    }

Here is the caller graph for this function:

escapeShellCmd()

static ilShellUtil::escapeShellCmd ( string  $a_arg )

static

Deprecated:

Definition at line 93 of file class.ilShellUtil.php.

Referenced by ilVirusScannerAntiVir\scanFile(), ilVirusScannerSophos\scanFile(), ilVirusScannerICapClient\scanFile(), ilVirusScannerClamAV\scanFile(), ilObjPoll\uploadImage(), and ilWkhtmlToPdfConfigFormGUI\validateForm().

                                                        : string
    {
        if (ini_get('safe_mode') == 1) {
            return $a_arg;
        }
        setlocale(
            LC_CTYPE,
            "UTF8",
            "en_US.UTF-8"
        ); // fix for PHP escapeshellcmd bug. See: http://bugs.php.net/bug.php?id=45132
        return escapeshellcmd($a_arg);
    }

Here is the caller graph for this function:

execConvert()

static ilShellUtil::execConvert ( string  $args )

static

execute convert command

Parameters

string

$args

Definition at line 210 of file class.ilShellUtil.php.

References execQuoted().

Referenced by ilObjUser\_uploadPersonalPicture(), ilLTIConsumeProviderIcon\convert(), convertImage(), ilPersonalProfileGUI\convertUserPicture(), ilObjectTileImage\delete(), resizeImage(), ilObjPortfolioBase\uploadImage(), ilObjBlog\uploadImage(), ilObjUserGUI\uploadUserPictureObject(), and ilObjMediaObject\uploadVideoPreviewPic().

                                                    : void
    {
        $args = self::escapeShellCmd($args);
        ilShellUtil::execQuoted(PATH_TO_CONVERT, $args);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

execQuoted()

static ilShellUtil::execQuoted ( string  $cmd, ?string  $args = null  )

static

Deprecated:

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

References $DIC, and ilUtil\isWindows().

Referenced by ilPreviewRenderer\createPreviewImage(), ilGitInformation\detect(), ilFFmpeg\exec(), execConvert(), ilCountPDFPages\extractAmountOfPagesByPath(), isConvertVersionAtLeast(), ilGhostscriptRenderer\renderImages(), ilWkhtmlToPdfRenderer\runCommandLine(), ilVirusScannerAntiVir\scanFile(), ilVirusScannerICapClient\scanFile(), ilVirusScannerClamAV\scanFile(), ilFileUtils\unzip(), ilObjPoll\uploadImage(), and ilFileUtils\zip().

                                                                        : array
    {
        global $DIC;

        if (ilUtil::isWindows() && strpos($cmd, " ") !== false && substr($cmd, 0, 1) !== '"') {
            // cmd won't work without quotes
            $cmd = '"' . $cmd . '"';
            if ($args) {
                // args are also quoted, workaround is to quote the whole command AGAIN
                // was fixed in php 5.2 (see php bug #25361)
                if (version_compare(phpversion(), "5.2", "<") && strpos($args, '"') !== false) {
                    $cmd = '"' . $cmd . " " . $args . '"';
                } // args are not quoted or php is fixed, just append
                else {
                    $cmd .= " " . $args;
                }
            }
        } // nothing todo, just append args
        elseif ($args) {
            $cmd .= " " . $args;
        }
        $arr = [];
        exec($cmd, $arr);
        $DIC->logger()->root()->debug("ilUtil::execQuoted: " . $cmd . ".");
        return $arr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getConvertCmd()

static ilShellUtil::getConvertCmd ( )

static

get convert command

Deprecated:

See also

ilShellUtil::execConvert()

Definition at line 161 of file class.ilShellUtil.php.

                                          : string
    {
        return PATH_TO_CONVERT;
    }

isConvertVersionAtLeast()

static ilShellUtil::isConvertVersionAtLeast ( string  $a_version )

static

Compare convert version numbers.

Parameters

string

$a_version

w.x.y-z

Returns

bool

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

References $version, and execQuoted().

Referenced by ilObjUser\_uploadPersonalPicture(), ilPersonalProfileGUI\convertUserPicture(), ilObjUserGUI\uploadUserPictureObject(), and ilObjMediaObject\uploadVideoPreviewPic().

                                                                     : bool
    {
        $current_version = ilShellUtil::execQuoted(PATH_TO_CONVERT, "--version");
        $current_version = self::processConvertVersion($current_version[0]);
        $version = self::processConvertVersion($a_version);
        if ($current_version >= $version) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

processConvertVersion()

static ilShellUtil::processConvertVersion ( string  $a_version )

staticprotected

Parse convert version string, e.g.

6.3.8-3, into integer

Parameters

string

$a_version

w.x.y-z

Returns

int

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

References $version.

                                                                      : int
    {
        if (preg_match("/([0-9]+)\.([0-9]+)\.([0-9]+)([\.|\-]([0-9]+))?/", $a_version, $match)) {
            $version = str_pad($match[1], 2, "0", STR_PAD_LEFT) .
                str_pad($match[2], 2, "0", STR_PAD_LEFT) .
                str_pad($match[3], 2, "0", STR_PAD_LEFT) .
                str_pad($match[5], 2, "0", STR_PAD_LEFT);
            return (int) $version;
        }
        return 0;
    }

resizeImage()

static ilShellUtil::resizeImage ( string  $a_from, string  $a_to, int  $a_width, int  $a_height, bool  $a_constrain_prop = false  )

static

resize image

Parameters

string	$a_from	source file
string	$a_to	target file
int	$a_width	target width
int	$a_height	target height

Definition at line 44 of file class.ilShellUtil.php.

References escapeShellArg(), and execConvert().

Referenced by ilObjMediaObject\_resizeImage(), and ILIAS\Style\Content\ImageManager\resizeImage().

     : void {
        if ($a_constrain_prop) {
            $size = " -geometry " . $a_width . "x" . $a_height . " ";
        } else {
            $size = " -resize " . $a_width . "x" . $a_height . "! ";
        }
        $convert_cmd = ilShellUtil::escapeShellArg($a_from) . " " . $size . ilShellUtil::escapeShellArg($a_to);

        ilShellUtil::execConvert($convert_cmd);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Services/Utilities/classes/class.ilShellUtil.php