class.ilShellUtil.php

Go to the documentation of this file.

<?php
 
class ilShellUtil
{
    public static function resizeImage(
        string $a_from,
        string $a_to,
        int $a_width,
        int $a_height,
        bool $a_constrain_prop = false
    ): 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);
    }
 
    public static function escapeShellArg(string $a_arg): 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);
    }
 
    protected static function processConvertVersion(string $a_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;
    }
 
    public static function escapeShellCmd(string $a_arg): 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);
    }
 
    public static function execQuoted(string $cmd, ?string $args = null): 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;
    }
 
    public static function isConvertVersionAtLeast(string $a_version): 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;
    }
 
    public static function getConvertCmd(): string
    {
        return PATH_TO_CONVERT;
    }
 
    public static function convertImage(
        string $a_from,
        string $a_to,
        string $a_target_format = "",
        string $a_geometry = "",
        string $a_background_color = ""
    ): 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);
    }
 
    public static function execConvert(string $args): void
    {
        $args = self::escapeShellCmd($args);
        ilShellUtil::execQuoted(PATH_TO_CONVERT, $args);
    }
}