tags if the current sapi is not 'cli'.
* Returns the output string instead of displaying it if $return is true.
*
* @param mixed $mixed variable or expression to display
* @param bool $return
*
* @return string|null
*/
public static function pre_r($mixed, $return = false)
{
if ($return) {
return "
" . print_r($mixed, true) . "
";
}
if (php_sapi_name() !== "cli") {
echo "
";
}
print_r($mixed);
if (php_sapi_name() !== "cli") {
echo "
";
} else {
echo "\n";
}
flush();
return null;
}
/**
* builds a full url given a protocol, hostname, base path and url
*
* @param string $protocol
* @param string $host
* @param string $base_path
* @param string $url
* @return string
*
* Initially the trailing slash of $base_path was optional, and conditionally appended.
* However on dynamically created sites, where the page is given as url parameter,
* the base path might not end with an url.
* Therefore do not append a slash, and **require** the $base_url to ending in a slash
* when needed.
* Vice versa, on using the local file system path of a file, make sure that the slash
* is appended (o.k. also for Windows)
*/
public static function build_url($protocol, $host, $base_path, $url)
{
$protocol = mb_strtolower($protocol);
if (empty($protocol)) {
$protocol = "file://";
}
if ($url === "") {
return null;
}
$url_lc = mb_strtolower($url);
// Is the url already fully qualified, a Data URI, or a reference to a named anchor?
// File-protocol URLs may require additional processing (e.g. for URLs with a relative path)
if (
(
mb_strpos($url_lc, "://") !== false
&& !in_array(substr($url_lc, 0, 7), ["file://", "phar://"], true)
)
|| mb_substr($url_lc, 0, 1) === "#"
|| mb_strpos($url_lc, "data:") === 0
|| mb_strpos($url_lc, "mailto:") === 0
|| mb_strpos($url_lc, "tel:") === 0
) {
return $url;
}
$res = "";
if (strpos($url_lc, "file://") === 0) {
$url = substr($url, 7);
$protocol = "file://";
} elseif (strpos($url_lc, "phar://") === 0) {
$res = substr($url, strpos($url_lc, ".phar")+5);
$url = substr($url, 7, strpos($url_lc, ".phar")-2);
$protocol = "phar://";
}
$ret = "";
$is_local_path = in_array($protocol, ["file://", "phar://"], true);
if ($is_local_path) {
//On Windows local file, an abs path can begin also with a '\' or a drive letter and colon
//drive: followed by a relative path would be a drive specific default folder.
//not known in php app code, treat as abs path
//($url[1] !== ':' || ($url[2]!=='\\' && $url[2]!=='/'))
if ($url[0] !== '/' && (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN' || (mb_strlen($url) > 1 && $url[0] !== '\\' && $url[1] !== ':'))) {
// For rel path and local access we ignore the host, and run the path through realpath()
$ret .= realpath($base_path) . '/';
}
$ret .= $url;
$ret = preg_replace('/\?(.*)$/', "", $ret);
$filepath = realpath($ret);
if ($filepath === false) {
return null;
}
$ret = "$protocol$filepath$res";
return $ret;
}
$ret = $protocol;
// Protocol relative urls (e.g. "//example.org/style.css")
if (strpos($url, '//') === 0) {
$ret .= substr($url, 2);
//remote urls with backslash in html/css are not really correct, but lets be genereous
} elseif ($url[0] === '/' || $url[0] === '\\') {
// Absolute path
$ret .= $host . $url;
} else {
// Relative path
//$base_path = $base_path !== "" ? rtrim($base_path, "/\\") . "/" : "";
$ret .= $host . $base_path . $url;
}
// URL should now be complete, final cleanup
$parsed_url = parse_url($ret);
// reproduced from https://www.php.net/manual/en/function.parse-url.php#106731
$scheme = isset($parsed_url['scheme']) ? $parsed_url['scheme'] . '://' : '';
$host = isset($parsed_url['host']) ? $parsed_url['host'] : '';
$port = isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '';
$user = isset($parsed_url['user']) ? $parsed_url['user'] : '';
$pass = isset($parsed_url['pass']) ? ':' . $parsed_url['pass'] : '';
$pass = ($user || $pass) ? "$pass@" : '';
$path = isset($parsed_url['path']) ? $parsed_url['path'] : '';
$query = isset($parsed_url['query']) ? '?' . $parsed_url['query'] : '';
$fragment = isset($parsed_url['fragment']) ? '#' . $parsed_url['fragment'] : '';
// partially reproduced from https://stackoverflow.com/a/1243431/264628
/* replace '//' or '/./' or '/foo/../' with '/' */
$re = array('#(/\.?/)#', '#/(?!\.\.)[^/]+/\.\./#');
for ($n=1; $n>0; $path=preg_replace($re, '/', $path, -1, $n)) {}
$ret = "$scheme$user$pass$host$port$path$query$fragment";
return $ret;
}
/**
* Builds a HTTP Content-Disposition header string using `$dispositionType`
* and `$filename`.
*
* If the filename contains any characters not in the ISO-8859-1 character
* set, a fallback filename will be included for clients not supporting the
* `filename*` parameter.
*
* @param string $dispositionType
* @param string $filename
* @return string
*/
public static function buildContentDispositionHeader($dispositionType, $filename)
{
$encoding = mb_detect_encoding($filename);
$fallbackfilename = mb_convert_encoding($filename, "ISO-8859-1", $encoding);
$fallbackfilename = str_replace("\"", "", $fallbackfilename);
$encodedfilename = rawurlencode($filename);
$contentDisposition = "Content-Disposition: $dispositionType; filename=\"$fallbackfilename\"";
if ($fallbackfilename !== $filename) {
$contentDisposition .= "; filename*=UTF-8''$encodedfilename";
}
return $contentDisposition;
}
/**
* Converts decimal numbers to roman numerals.
*
* As numbers larger than 3999 (and smaller than 1) cannot be represented in
* the standard form of roman numerals, those are left in decimal form.
*
* See https://en.wikipedia.org/wiki/Roman_numerals#Standard_form
*
* @param int|string $num
*
* @throws Exception
* @return string
*/
public static function dec2roman($num): string
{
static $ones = ["", "i", "ii", "iii", "iv", "v", "vi", "vii", "viii", "ix"];
static $tens = ["", "x", "xx", "xxx", "xl", "l", "lx", "lxx", "lxxx", "xc"];
static $hund = ["", "c", "cc", "ccc", "cd", "d", "dc", "dcc", "dccc", "cm"];
static $thou = ["", "m", "mm", "mmm"];
if (!is_numeric($num)) {
throw new Exception("dec2roman() requires a numeric argument.");
}
if ($num >= 4000 || $num <= 0) {
return (string) $num;
}
$num = strrev((string)$num);
$ret = "";
switch (mb_strlen($num)) {
/** @noinspection PhpMissingBreakStatementInspection */
case 4:
$ret .= $thou[$num[3]];
/** @noinspection PhpMissingBreakStatementInspection */
case 3:
$ret .= $hund[$num[2]];
/** @noinspection PhpMissingBreakStatementInspection */
case 2:
$ret .= $tens[$num[1]];
/** @noinspection PhpMissingBreakStatementInspection */
case 1:
$ret .= $ones[$num[0]];
default:
break;
}
return $ret;
}
/**
* Restrict a length to the given range.
*
* If min > max, the result is min.
*
* @param float $length
* @param float $min
* @param float $max
*
* @return float
*/
public static function clamp(float $length, float $min, float $max): float
{
return max($min, min($length, $max));
}
/**
* Determines whether $value is a percentage or not
*
* @param string|float|int $value
*
* @return bool
*/
public static function is_percent($value): bool
{
return is_string($value) && false !== mb_strpos($value, "%");
}
/**
* Parses a data URI scheme
* http://en.wikipedia.org/wiki/Data_URI_scheme
*
* @param string $data_uri The data URI to parse
*
* @return array|bool The result with charset, mime type and decoded data
*/
public static function parse_data_uri($data_uri)
{
if (!preg_match('/^data:(?P[a-z0-9\/+-.]+)(;charset=(?P[a-z0-9-])+)?(?P;base64)?\,(?P.*)?/is', $data_uri, $match)) {
return false;
}
$match['data'] = rawurldecode($match['data']);
$result = [
'charset' => $match['charset'] ? $match['charset'] : 'US-ASCII',
'mime' => $match['mime'] ? $match['mime'] : 'text/plain',
'data' => $match['base64'] ? base64_decode($match['data']) : $match['data'],
];
return $result;
}
/**
* Encodes a Uniform Resource Identifier (URI) by replacing non-alphanumeric
* characters with a percent (%) sign followed by two hex digits, excepting
* characters in the URI reserved character set.
*
* Assumes that the URI is a complete URI, so does not encode reserved
* characters that have special meaning in the URI.
*
* Simulates the encodeURI function available in JavaScript
* https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/encodeURI
*
* Source: http://stackoverflow.com/q/4929584/264628
*
* @param string $uri The URI to encode
* @return string The original URL with special characters encoded
*/
public static function encodeURI($uri) {
$unescaped = [
'%2D'=>'-','%5F'=>'_','%2E'=>'.','%21'=>'!', '%7E'=>'~',
'%2A'=>'*', '%27'=>"'", '%28'=>'(', '%29'=>')'
];
$reserved = [
'%3B'=>';','%2C'=>',','%2F'=>'/','%3F'=>'?','%3A'=>':',
'%40'=>'@','%26'=>'&','%3D'=>'=','%2B'=>'+','%24'=>'$'
];
$score = [
'%23'=>'#'
];
return preg_replace(
'/%25([a-fA-F0-9]{2,2})/',
'%$1',
strtr(rawurlencode($uri), array_merge($reserved, $unescaped, $score))
);
}
/**
* Decoder for RLE8 compression in windows bitmaps
* http://msdn.microsoft.com/library/default.asp?url=/library/en-us/gdi/bitmaps_6x0u.asp
*
* @param string $str Data to decode
* @param int $width Image width
*
* @return string
*/
public static function rle8_decode($str, $width)
{
$lineWidth = $width + (3 - ($width - 1) % 4);
$out = '';
$cnt = strlen($str);
for ($i = 0; $i < $cnt; $i++) {
$o = ord($str[$i]);
switch ($o) {
case 0: # ESCAPE
$i++;
switch (ord($str[$i])) {
case 0: # NEW LINE
$padCnt = $lineWidth - strlen($out) % $lineWidth;
if ($padCnt < $lineWidth) {
$out .= str_repeat(chr(0), $padCnt); # pad line
}
break;
case 1: # END OF FILE
$padCnt = $lineWidth - strlen($out) % $lineWidth;
if ($padCnt < $lineWidth) {
$out .= str_repeat(chr(0), $padCnt); # pad line
}
break 3;
case 2: # DELTA
$i += 2;
break;
default: # ABSOLUTE MODE
$num = ord($str[$i]);
for ($j = 0; $j < $num; $j++) {
$out .= $str[++$i];
}
if ($num % 2) {
$i++;
}
}
break;
default:
$out .= str_repeat($str[++$i], $o);
}
}
return $out;
}
/**
* Decoder for RLE4 compression in windows bitmaps
* see http://msdn.microsoft.com/library/default.asp?url=/library/en-us/gdi/bitmaps_6x0u.asp
*
* @param string $str Data to decode
* @param int $width Image width
*
* @return string
*/
public static function rle4_decode($str, $width)
{
$w = floor($width / 2) + ($width % 2);
$lineWidth = $w + (3 - (($width - 1) / 2) % 4);
$pixels = [];
$cnt = strlen($str);
$c = 0;
for ($i = 0; $i < $cnt; $i++) {
$o = ord($str[$i]);
switch ($o) {
case 0: # ESCAPE
$i++;
switch (ord($str[$i])) {
case 0: # NEW LINE
while (count($pixels) % $lineWidth != 0) {
$pixels[] = 0;
}
break;
case 1: # END OF FILE
while (count($pixels) % $lineWidth != 0) {
$pixels[] = 0;
}
break 3;
case 2: # DELTA
$i += 2;
break;
default: # ABSOLUTE MODE
$num = ord($str[$i]);
for ($j = 0; $j < $num; $j++) {
if ($j % 2 == 0) {
$c = ord($str[++$i]);
$pixels[] = ($c & 240) >> 4;
} else {
$pixels[] = $c & 15;
}
}
if ($num % 2 == 0) {
$i++;
}
}
break;
default:
$c = ord($str[++$i]);
for ($j = 0; $j < $o; $j++) {
$pixels[] = ($j % 2 == 0 ? ($c & 240) >> 4 : $c & 15);
}
}
}
$out = '';
if (count($pixels) % 2) {
$pixels[] = 0;
}
$cnt = count($pixels) / 2;
for ($i = 0; $i < $cnt; $i++) {
$out .= chr(16 * $pixels[2 * $i] + $pixels[2 * $i + 1]);
}
return $out;
}
/**
* parse a full url or pathname and return an array(protocol, host, path,
* file + query + fragment)
*
* @param string $url
* @return array
*/
public static function explode_url($url)
{
$protocol = "";
$host = "";
$path = "";
$file = "";
$res = "";
$arr = parse_url($url);
if ( isset($arr["scheme"]) ) {
$arr["scheme"] = mb_strtolower($arr["scheme"]);
}
if (isset($arr["scheme"]) && $arr["scheme"] !== "file" && $arr["scheme"] !== "phar" && strlen($arr["scheme"]) > 1) {
$protocol = $arr["scheme"] . "://";
if (isset($arr["user"])) {
$host .= $arr["user"];
if (isset($arr["pass"])) {
$host .= ":" . $arr["pass"];
}
$host .= "@";
}
if (isset($arr["host"])) {
$host .= $arr["host"];
}
if (isset($arr["port"])) {
$host .= ":" . $arr["port"];
}
if (isset($arr["path"]) && $arr["path"] !== "") {
// Do we have a trailing slash?
if ($arr["path"][mb_strlen($arr["path"]) - 1] === "/") {
$path = $arr["path"];
$file = "";
} else {
$path = rtrim(dirname($arr["path"]), '/\\') . "/";
$file = basename($arr["path"]);
}
}
if (isset($arr["query"])) {
$file .= "?" . $arr["query"];
}
if (isset($arr["fragment"])) {
$file .= "#" . $arr["fragment"];
}
} else {
$protocol = "";
$host = ""; // localhost, really
$i = mb_stripos($url, "://");
if ($i !== false) {
$protocol = mb_strtolower(mb_substr($url, 0, $i + 3));
$url = mb_substr($url, $i + 3);
} else {
$protocol = "file://";
}
if ($protocol === "phar://") {
$res = substr($url, stripos($url, ".phar")+5);
$url = substr($url, 7, stripos($url, ".phar")-2);
}
$file = basename($url);
$path = dirname($url) . "/";
}
$ret = [$protocol, $host, $path, $file,
"protocol" => $protocol,
"host" => $host,
"path" => $path,
"file" => $file,
"resource" => $res];
return $ret;
}
/**
* Print debug messages
*
* @param string $type The type of debug messages to print
* @param string $msg The message to show
*/
public static function dompdf_debug($type, $msg)
{
global $_DOMPDF_DEBUG_TYPES, $_dompdf_show_warnings, $_dompdf_debug;
if (isset($_DOMPDF_DEBUG_TYPES[$type]) && ($_dompdf_show_warnings || $_dompdf_debug)) {
$arr = debug_backtrace();
echo basename($arr[0]["file"]) . " (" . $arr[0]["line"] . "): " . $arr[1]["function"] . ": ";
Helpers::pre_r($msg);
}
}
/**
* Stores warnings in an array for display later
* This function allows warnings generated by the DomDocument parser
* and CSS loader ({@link Stylesheet}) to be captured and displayed
* later. Without this function, errors are displayed immediately and
* PDF streaming is impossible.
* @see http://www.php.net/manual/en/function.set-error_handler.php
*
* @param int $errno
* @param string $errstr
* @param string $errfile
* @param string $errline
*
* @throws Exception
*/
public static function record_warnings($errno, $errstr, $errfile, $errline)
{
// Not a warning or notice
if (!($errno & (E_WARNING | E_NOTICE | E_USER_NOTICE | E_USER_WARNING | E_STRICT | E_DEPRECATED | E_USER_DEPRECATED))) {
throw new Exception($errstr . " $errno");
}
global $_dompdf_warnings;
global $_dompdf_show_warnings;
if ($_dompdf_show_warnings) {
echo $errstr . "\n";
}
$_dompdf_warnings[] = $errstr;
}
/**
* Get Unicode code point of character
*
* Shim for use on systems running PHP < 7.2
*
* @param string $c
* @param string $encoding
* @return int|false
*/
public static function uniord(string $c, string $encoding = null)
{
if (function_exists("mb_ord")) {
if (PHP_VERSION_ID < 80000 && $encoding === null) {
// in PHP < 8 the encoding argument, if supplied, must be a valid encoding
$encoding = "UTF-8";
}
return mb_ord($c, $encoding);
}
if ($encoding != "UTF-8" && $encoding !== null) {
$c = mb_convert_encoding($c, "UTF-8", $encoding);
}
$length = mb_strlen(mb_substr($c, 0, 1), '8bit');
$ord = false;
$bytes = [];
$numbytes = 1;
for ($i = 0; $i < $length; $i++) {
$o = ord($c[$i]); // get one string character at time
if (count($bytes) === 0) { // get starting octect
if ($o <= 0x7F) {
$ord = $o;
$numbytes = 1;
} elseif (($o >> 0x05) === 0x06) { // 2 bytes character (0x06 = 110 BIN)
$bytes[] = ($o - 0xC0) << 0x06;
$numbytes = 2;
} elseif (($o >> 0x04) === 0x0E) { // 3 bytes character (0x0E = 1110 BIN)
$bytes[] = ($o - 0xE0) << 0x0C;
$numbytes = 3;
} elseif (($o >> 0x03) === 0x1E) { // 4 bytes character (0x1E = 11110 BIN)
$bytes[] = ($o - 0xF0) << 0x12;
$numbytes = 4;
} else {
$ord = false;
break;
}
} elseif (($o >> 0x06) === 0x02) { // bytes 2, 3 and 4 must start with 0x02 = 10 BIN
$bytes[] = $o - 0x80;
if (count($bytes) === $numbytes) {
// compose UTF-8 bytes to a single unicode value
$o = $bytes[0];
for ($j = 1; $j < $numbytes; $j++) {
$o += ($bytes[$j] << (($numbytes - $j - 1) * 0x06));
}
if ((($o >= 0xD800) and ($o <= 0xDFFF)) or ($o >= 0x10FFFF)) {
// The definition of UTF-8 prohibits encoding character numbers between
// U+D800 and U+DFFF, which are reserved for use with the UTF-16
// encoding form (as surrogate pairs) and do not directly represent
// characters.
return false;
} else {
$ord = $o; // add char to array
}
// reset data for next char
$bytes = [];
$numbytes = 1;
}
} else {
$ord = false;
break;
}
}
return $ord;
}
/**
* Return character by Unicode code point value
*
* Shim for use on systems running PHP < 7.2
*
* @param int $c
* @param string $encoding
* @return string|false
*/
public static function unichr(int $c, string $encoding = null)
{
if (function_exists("mb_chr")) {
if (PHP_VERSION_ID < 80000 && $encoding === null) {
// in PHP < 8 the encoding argument, if supplied, must be a valid encoding
$encoding = "UTF-8";
}
return mb_chr($c, $encoding);
}
$chr = false;
if ($c <= 0x7F) {
$chr = chr($c);
} elseif ($c <= 0x7FF) {
$chr = chr(0xC0 | $c >> 6) . chr(0x80 | $c & 0x3F);
} elseif ($c <= 0xFFFF) {
$chr = chr(0xE0 | $c >> 12) . chr(0x80 | $c >> 6 & 0x3F)
. chr(0x80 | $c & 0x3F);
} elseif ($c <= 0x10FFFF) {
$chr = chr(0xF0 | $c >> 18) . chr(0x80 | $c >> 12 & 0x3F)
. chr(0x80 | $c >> 6 & 0x3F)
. chr(0x80 | $c & 0x3F);
}
return $chr;
}
/**
* Converts a CMYK color to RGB
*
* @param float|float[] $c
* @param float $m
* @param float $y
* @param float $k
*
* @return float[]
*/
public static function cmyk_to_rgb($c, $m = null, $y = null, $k = null)
{
if (is_array($c)) {
[$c, $m, $y, $k] = $c;
}
$c *= 255;
$m *= 255;
$y *= 255;
$k *= 255;
$r = (1 - round(2.55 * ($c + $k)));
$g = (1 - round(2.55 * ($m + $k)));
$b = (1 - round(2.55 * ($y + $k)));
if ($r < 0) {
$r = 0;
}
if ($g < 0) {
$g = 0;
}
if ($b < 0) {
$b = 0;
}
return [
$r, $g, $b,
"r" => $r, "g" => $g, "b" => $b
];
}
/**
* getimagesize doesn't give a good size for 32bit BMP image v5
*
* @param string $filename
* @param resource $context
* @return array An array of three elements: width and height as
* `float|int`, and image type as `string|null`.
*/
public static function dompdf_getimagesize($filename, $context = null)
{
static $cache = [];
if (isset($cache[$filename])) {
return $cache[$filename];
}
[$width, $height, $type] = getimagesize($filename);
// Custom types
$types = [
IMAGETYPE_JPEG => "jpeg",
IMAGETYPE_GIF => "gif",
IMAGETYPE_BMP => "bmp",
IMAGETYPE_PNG => "png",
IMAGETYPE_WEBP => "webp",
];
$type = $types[$type] ?? null;
if ($width == null || $height == null) {
[$data] = Helpers::getFileContent($filename, $context);
if ($data !== null) {
if (substr($data, 0, 2) === "BM") {
$meta = unpack("vtype/Vfilesize/Vreserved/Voffset/Vheadersize/Vwidth/Vheight", $data);
$width = (int) $meta["width"];
$height = (int) $meta["height"];
$type = "bmp";
} elseif (strpos($data, "