, might contain further attributes) and wrap it * around * $value. If $flagOmitEmpty==true && $value=='': return ''. * * @param string $tag * @param string $value * @param bool|false $omitIfValueEmpty * * @return string */ public static function wrapTag($tag, $value, $omitIfValueEmpty = false) { $tag = trim($tag); if ($tag == '' || ($omitIfValueEmpty && $value == "")) { return $value; } $tagArray = explode('>', $tag, 2); if (count($tagArray) > 1 && $tagArray[1] != '') { $value = self::wrapTag($tagArray[1], $value, $omitIfValueEmpty); $tag = $tagArray[0] . '>'; } // a)

, b) $arr = explode(' ', $tag); $tagPlain = (count($arr) === 1) ? substr($arr[0], 1, strlen($arr[0]) - 2) : substr($arr[0], 1); $closing = ''; return $tag . $value . $closing; } /** * Wraps some $inner fragment with a CSS styled $tooltipText . CSS is configured in 'Resources/Public/qfq-jqw.css'. * * Based on: http://www.w3schools.com/howto/howto_css_tooltip.asp * * @param string $htmlId * @param string $tooltipText * * @return string */ public static function doTooltip($htmlId, $tooltipText) { return " $\""$ "; } /** * Format's an attribute: $type=$value. If $flagOmitEmpty==true && $value=='': return ''. * Add's a space at the end. * * @param string $type * @param string|array $value * @param bool $flagOmitEmpty * @param string $modeEscape * * @return string correctly fomratted attribute. Space at the end. * @throws CodeException */ public static function doAttribute($type, $value, $flagOmitEmpty = true, $modeEscape = ESCAPE_WITH_BACKSLASH) { // several attributes might be given as an array - concat to a string if (is_array($value)) { $value = implode(' ', $value); } if ($flagOmitEmpty && $value === "") { return ''; } switch (strtolower($type)) { case 'size': case 'maxlength': // empty or '0' for attributes of type 'size' or 'maxlength' result in unsuable input elements: skip this. if ($value === '' || $value == 0) { return ''; } break; // Bad idea to do urlencode on this place: it will convert ?, &, ... which are necessary for a proper URL. // Instead the value of a parameter needs to encode. Unfortunately, it's too late on this place. // case 'href': // $value = urlencode($value); // break; default: break; } $value = self::escapeDoubleTick(trim($value), $modeEscape); return $type . '="' . $value . '" '; } /** * Escapes Double Ticks ("), which are not already escaped. * modeEscape: ESCAPE_WITH_BACKSLASH | ESCAPE_WITH_HTML_QUOTE * * TinyMCE: Encoding JS Attributes (keys & values) for TinyMCE needs to be encapsulated in '"' instead of '\"'. * * @param $str * @param string $modeEscape * * @return string * @throws CodeException */ public static function escapeDoubleTick($str, $modeEscape = ESCAPE_WITH_BACKSLASH) { $newStr = ''; for ($ii = 0; $ii < strlen($str); $ii++) { if ($str[$ii] === '"') { if ($ii === 0 || $str[$ii - 1] != '\\') { switch ($modeEscape) { case ESCAPE_WITH_BACKSLASH: $newStr .= '\\'; break; case ESCAPE_WITH_HTML_QUOTE: $newStr .= '"'; continue 2; default: throw new CodeException('Unknown modeEscape=' . $modeEscape, ERROR_UNKNOWN_ESCAPE_MODE); } } } $newStr .= $str[$ii]; } return $newStr; } /** * Format's an attribute and inserts them at the beginning of the $htmlTag: * If $flagOmitEmpty==true && $value=='': insert nothing * * @param string $htmlTag with open and closing angle. * @param string $type * @param string|array $value * @param bool $flagOmitEmpty * @param string $modeEscape * * @return string correctly fomratted attribute. Space at the end. * @throws CodeException */ public static function insertAttribute($htmlTag, $type, $value, $flagOmitEmpty = true, $modeEscape = ESCAPE_WITH_BACKSLASH) { $htmlTag = trim($htmlTag); // e.g. '

1979-02-01 00:00:00 * 01.02.13 3:24 > 1979-02-01 03:24:00 * 1.2.1979 14:21:5 > 1979-02-01 14:21:05 * * @param string $dateTimeString * * @return string * @throws UserFormException */ public static function dateTimeGermanToInternational($dateTimeString) { $dateRaw = ''; $timeRaw = ''; // const REGEXP_DATE_INT_ = '^\d{2,4}-\d{2}-\d{2}$'; // const REGEXP_DATE_GER = '^\d{1,2}\.\d{1,2}\.\d{2}(\d{2})?$'; // const REGEXP_TIME = '^\d{1,2}:\d{1,2}(:\d{1,2})?$'; $tmpArr = explode(' ', $dateTimeString); switch (count($tmpArr)) { case 0: return ''; case 1: if (strpos($tmpArr[0], ':') === false) { $dateRaw = $tmpArr[0]; } else { $timeRaw = $tmpArr[0]; } break; case 2: $dateRaw = $tmpArr[0]; $timeRaw = $tmpArr[1]; break; default: throw new UserFormException('Date/time format not recognised.', ERROR_DATE_TIME_FORMAT_NOT_RECOGNISED); break; } if ($dateRaw === '') { $date = '0000-00-00'; } else { // International format: YYYY-MM-DD if (preg_match('/^\d{4}-\d{2}-\d{2}$/', $dateRaw) === 1) { $date = $dateRaw; // German format: 1.1.01 - 11.12.1234 } elseif (preg_match('/^\d{1,2}\.\d{1,2}\.\d{2}(\d{2})?$/', $dateRaw) === 1) { $tmpArr = explode('.', $dateRaw); if ($tmpArr[2] < 70) { $tmpArr[2] = 2000 + $tmpArr[2]; } elseif ($tmpArr[2] < 100) { $tmpArr[2] = 1900 + $tmpArr[2]; } $date = sprintf("%04d-%02d-%02d", $tmpArr[2], $tmpArr[1], $tmpArr[0]); } else { throw new UserFormException('Date/time format not recognised.', ERROR_DATE_TIME_FORMAT_NOT_RECOGNISED); } } if ($timeRaw === '') { $time = '00:00:00'; } else { if (preg_match('/^\d{1,2}:\d{1,2}(:\d{1,2})?$/', $timeRaw) !== 1) { throw new UserFormException('Date/time format not recognised.', ERROR_DATE_TIME_FORMAT_NOT_RECOGNISED); } $tmpArr = explode(':', $timeRaw); switch (count($tmpArr)) { case 2: $time = sprintf("%02d:%02d:00", $tmpArr[0], $tmpArr[1]); break; case 3: $time = sprintf("%02d:%02d:%02d", $tmpArr[0], $tmpArr[1], $tmpArr[2]); break; default: throw new UserFormException('Date/time format not recognised.', ERROR_DATE_TIME_FORMAT_NOT_RECOGNISED); break; } } return $date . ' ' . $time; } /** * @param string $type date | datetime | time * @param string $format FORMAT_DATE_INTERNATIONAL | FORMAT_DATE_GERMAN * @param string $showSeconds * * @return string * @throws UserFormException */ public static function dateTimeRegexp($type, $format) { if ($format === FORMAT_DATE_GERMAN) { // yyyy-mm-dd | 0000-00-00 $date = '(([1-9]|0[1-9]|1[0-9]|2[0-9]|3[01])\.([1-9]|0[1-9]|1[012])\.([0-9]{4}|[0-9]{2})|00\.00\.(00){1,2})'; } else { // FORMAT_DATE_INTERNATIONAL: [d]d.[m]m.[yy]yy | 00.00.0000 $date = '([0-9]{4}-([1-9]|0[1-9]|1[012])-([1-9]|0[1-9]|1[0-9]|2[0-9]|3[01])|0000-00-00)'; } // hh:mm[:ss] $time = '(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){1,2}'; switch ($type) { case 'date': $pattern = $date; break; case 'datetime': $pattern = $date . ' ' . $time; break; case 'time': $pattern = $time; break; default: throw new UserFormException("Unknown mode: '$type'", ERROR_UNKNOWN_MODE); } return '^' . $pattern . '$'; } /** * Parses $dateTimeString. If a date is given, detect international or german format automatically. * Convert to $dateFormat. 'yy' and 'd' will be converted to 'yyyy' and 'dd' * Returned value will be 'date only', 'datetime' oder 'time only', depending on the input value. * * @param string $dateTimeString * @param string $dateFormat * @param string $showZero * @param string $showTime * @param string $showSeconds * * @return string * @throws UserFormException */ public static function convertDateTime($dateTimeString, $dateFormat, $showZero, $showTime, $showSeconds) { $givenDate = ''; $givenTime = ''; $newDate = ''; $newTime = ''; $delim = ''; $dateTimeString = trim($dateTimeString); switch ($dateTimeString) { case '': case '0': case '0000-00-00 00:00:00': case '0000-00-00': case '00:00:00': return (self::dateTimeZero($dateFormat, $showZero, $showTime, $showSeconds)); break; default: break; } // Main convert $arr = explode(' ', $dateTimeString); switch (count($arr)) { case 1: if (strpos($dateTimeString, ':') === false) { $givenDate = $dateTimeString; } else { $givenTime = $dateTimeString; } break; case 2: $givenDate = $arr[0]; $givenTime = $arr[1]; default: } // Date if ($givenDate != '') { if ($givenDate == '0') $givenDate = '0000-00-00'; $arr = self::splitDateToArray($givenDate); switch ($dateFormat) { case FORMAT_DATE_INTERNATIONAL: $newDate = sprintf("%04d-%02d-%02d", $arr[0], $arr[1], $arr[2]); break; case FORMAT_DATE_GERMAN: $newDate = sprintf("%02d.%02d.%04d", $arr[2], $arr[1], $arr[0]); default: } } // Time if ($givenTime != '') { if ($givenTime == '0') $givenTime = '0:0:0'; $arr = explode(':', $givenTime); if (count($arr) < 3) { $arr[2] = 0; } if ($showSeconds == 1) { $newTime = sprintf("%02d:%02d:%02d", $arr[0], $arr[1], $arr[2]); } else { $newTime = sprintf("%02d:%02d", $arr[0], $arr[1]); } } if (strlen($dateTimeString) > 15) { $delim = ' '; } return $newDate . $delim . $newTime; } /** * Returns a representation of 0 in a choosen variant. * * @param string $dateFormat FORMAT_DATE_INTERNATIONAL | FORMAT_DATE_GERMAN * @param string $showZero * @param string $showTime '0' | '1' * @param string $showSeconds '0' | '1' * * @return string */ private static function dateTimeZero($dateFormat, $showZero, $showTime, $showSeconds) { if ($showZero != '1') { return ''; } // $dateFormat (INT/GER), $showTime, $showSeconds $arr[0][0][0] = '0000-00-00'; $arr[0][0][1] = '0000-00-00'; $arr[0][1][0] = '0000-00-00 00:00'; $arr[0][1][1] = '0000-00-00 00:00:00'; $arr[1][0][0] = '00.00.0000'; $arr[1][0][1] = '00.00.0000'; $arr[1][1][0] = '00.00.0000 00:00'; $arr[1][1][1] = '00.00.0000 00:00:00'; $showFormat = ($dateFormat === FORMAT_DATE_INTERNATIONAL) ? 0 : 1; return $arr[$showFormat][$showTime][$showSeconds]; } /** * Split date FORMAT_DATE_GERMAN | FORMAT_DATE_INTERNATIONAL to array with arr[0]=yyyy, arr[1]=mm, arr[2]=dd. * * @param string $dateString * * @return array * @throws UserFormException */ private static function splitDateToArray($dateString) { if (strpos($dateString, '-') === false) { // FORMAT_DATE_GERMAN $arr = explode('.', $dateString); if (count($arr) != 3) { throw new UserFormException("Unexpected format for date: $dateString", ERROR_DATE_UNEXPECTED_FORMAT); } $tmp = $arr[0]; $arr[0] = $arr[2]; $arr[2] = $tmp; } else { // FORMAT_DATE_INTERNATIONAL $arr = explode('-', $dateString); if (count($arr) != 3) { throw new UserFormException("Unexpected format for date: $dateString", ERROR_DATE_UNEXPECTED_FORMAT); } } // Adjust yy to yyyy. See https://dev.mysql.com/doc/refman/5.7/en/datetime.html > Dates containing two-digit year values ... if ($arr[0] < 100) { $add = ($arr[0] < 70) ? 2000 : 1900; $arr[0] = $add + $arr[0]; } return $arr; } /** * Calculates the placeholder for date/dateTime/local input fields. * * @param array $formElement * * @return string * @throws UserFormException */ public static function getDateTimePlaceholder(array $formElement) { $timePattern = ($formElement[FE_SHOW_SECONDS] == 1) ? 'hh:mm:ss' : 'hh:mm'; switch ($formElement[FE_TYPE]) { case 'date': $placeholder = $formElement[FE_DATE_FORMAT]; break; case 'datetime': $placeholder = $formElement[FE_DATE_FORMAT] . ' ' . $timePattern; break; case 'time': $placeholder = $timePattern; break; default: throw new UserFormException("Unexpected Formelement type: '" . $formElement[FE_TYPE] . "'", ERROR_FORMELEMENT_TYPE); } return $placeholder; } /** * Encrypt curly braces by an uncommon string. Helps preventing unwished action on curly braces. * * @param string $text * * @return mixed */ public static function encryptDoubleCurlyBraces($text) { $text = str_replace('{{', LONG_CURLY_OPEN, $text); $text = str_replace('}}', LONG_CURLY_CLOSE, $text); return $text; } /** * Decrypt curly braces by an uncommon string. Helps preventing unwished action on curly braces * * @param string $text * * @return mixed */ public static function decryptDoubleCurlyBraces($text) { if (!is_string($text)) { return $text; } $text = str_replace(LONG_CURLY_OPEN, '{{', $text); $text = str_replace(LONG_CURLY_CLOSE, '}}', $text); return $text; } /** * @param int $length Length of the required hash string * * @return string A random alphanumeric hash */ public static function randomAlphaNum($length) { $possible_characters = "abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ"; $string = ""; while (strlen($string) < $length) { $string .= substr($possible_characters, rand() % (strlen($possible_characters)), 1); } return ($string); } /** * Concatenate URL and Parameter. Depending of if there is a '?' in URL or not, append the param with '?' or '&'.. * * @param string $url * @param string $param * * @return string */ public static function concatUrlParam($url, $param) { if ($param == '') { return $url; } $token = (strpos($url, '?') === false) ? '?' : '&'; return $url . $token . $param; } /** * Concatenate $host, $path and $query. A given $host will always append a '/' if none is given. * End of $path, there is no assumption to append '/' - the user needs full control. * $query: trailing 'index.php' will be skipped. * * If HOST and PATH is combined in a var, pass the value as $hostOrPath, leave $host empty. * * @param string $host * @param string $hostOrPath * @param string $query * * @return string * @throws CodeException */ public static function mergeUrlComponents($host, $hostOrPath, $query) { $url = ''; $pre = ''; if ($host != '' && substr($host, -1, 1) != '/') { $host .= '/'; } if ($host != '' && substr($hostOrPath, 0, 1) == '/') { $hostOrPath = substr($hostOrPath, 1); } if ($host != '' || $hostOrPath != '') { $url = $host . $hostOrPath; } if (substr($query, 0, 9) == 'index.php') { $query = substr($query, 9); } if (false !== strpos(substr($query, 1), '?')) { throw new CodeException('Found a "?" after the beginning of the query - this is forbidden', ERROR_BROKEN_PARAMETER); } if ($query != '') { $url = $url . '?' . $query; $url = str_replace('??', '?', $url); } return $url; } /** * Set Defaults for the current formElement. * * @param array $formElement * * @return array */ public static function setFeDefaults(array $formElement, array $formSpec = array()) { $store = Store::getInstance(); // Some Defaults self::setIfNotSet($formElement, FE_SHOW_SECONDS, '0'); self::setIfNotSet($formElement, FE_SHOW_ZERO, '0'); self::setIfNotSet($formElement, FE_HIDE_ZERO, '0'); self::setIfNotSet($formElement, FE_DATE_FORMAT, $store->getVar(SYSTEM_DATE_FORMAT, STORE_SYSTEM)); self::setIfNotSet($formElement, FE_HTML_BEFORE); self::setIfNotSet($formElement, FE_HTML_AFTER); self::setIfNotSet($formElement, FE_SUBRECORD_TABLE_CLASS, 'table table-hover'); if (count($formSpec) > 0) { self::setIfNotSet($formElement, F_BS_LABEL_COLUMNS, $formSpec[F_BS_LABEL_COLUMNS], ''); self::setIfNotSet($formElement, F_BS_INPUT_COLUMNS, $formSpec[F_BS_INPUT_COLUMNS], ''); self::setIfNotSet($formElement, F_BS_NOTE_COLUMNS, $formSpec[F_BS_NOTE_COLUMNS], ''); } if ($formElement[FE_MODE_SQL] != '') { $formElement[FE_MODE] = $formElement[FE_MODE_SQL]; } if (isset($formSpec[F_MODE])) { $formElement[FE_MODE] = self::applyFormModeToFormElement($formElement[FE_MODE], $formSpec[F_MODE]); } // Will be used to change dynamicUpdate behaviour if (isset($formElement[FE_WRAP_ROW_LABEL_INPUT_NOTE])) { $formElement[FE_FLAG_ROW_OPEN_TAG] = Support::findInSet('row', $formElement[FE_WRAP_ROW_LABEL_INPUT_NOTE]); $formElement[FE_FLAG_ROW_CLOSE_TAG] = Support::findInSet('/row', $formElement[FE_WRAP_ROW_LABEL_INPUT_NOTE]); } else { $formElement[FE_FLAG_ROW_OPEN_TAG] = true; $formElement[FE_FLAG_ROW_CLOSE_TAG] = false; } return $formElement; } /** * Depending on $formMode and $feMode, calculate a new $feMode. * - If $formMode='' : no change. * - If $formMode=F_MODE_READ_ONLY: set feMode=FE_MODE_READ_ONLY, for all visible elements. * - If $formMode=F_MODE_REQUIRED_OFF: set feMode=FE_MODE_SHOW, who have have FE_MODE_REQUIRE before. * * @param string $feMode FE_MODE_SHOW | FE_MODE_REQUIRED | FE_MODE_READONLY | FE_MODE_HIDDEN | * @param string $formMode '' | F_MODE_READONLY | F_MODE_REQUIRED_OFF * * @return array|string * @throws CodeException */ private function applyFormModeToFormElement($feMode, $formMode) { if ($formMode == '') { return $feMode; //no change } switch ($feMode) { case FE_MODE_HIDDEN: case FE_MODE_READONLY: break; case FE_MODE_SHOW: case FE_MODE_REQUIRED: if ($formMode == F_MODE_READONLY) { $feMode = FE_MODE_READONLY; } elseif ($formMode == F_MODE_REQUIRED_OFF && $feMode = FE_MODE_REQUIRED) { $feMode = FE_MODE_SHOW; } break; default: throw new CodeException('Unknown mode: ' . $feMode, ERROR_UNKNOWN_MODE); } return $feMode; } /** * Looks in $arr if there is an element $index. If not, set it to $value. * If $overwriteThis!=false, replace the the original value with $value, if $arr[$index]==$overwriteThis. * * @param array $arr * @param string $index * @param string $value * @param string|bool $overwriteThis If there is already something which is equal to $overwrite: take new default. * * @return mixed */ public static function setIfNotSet(array &$arr, $index, $value = '', $overwriteThis = false) { if (!isset($arr[$index])) { $arr[$index] = $value; } if ($overwriteThis !== false && $arr[$index] === $overwriteThis) { $arr[$index] = $value; } return $arr[$index]; } /** * @param string $filename * @param string $extend * * @return string */ public static function extendFilename($filename, $extend) { return $filename . $extend; } /** * Creates all necessary directories in $pathFileName, but not the last part, the filename. A filename has to be * specified. * * @param string $pathFileName Path with Filename * * @throws UserFormException */ public static function mkDirParent($pathFileName) { $path = ""; // Teile "Directory/File.Extension" auf $pathParts = pathinfo($pathFileName); // Zerlege Pfad in einzelne Directories $arr = explode("/", $pathParts["dirname"]); // Durchlaufe die einzelnen Dirs und überprüfe ob sie angelegt sind. // Wenn nicht, lege sie an. foreach ($arr as $part) { $path .= $part; // Check ob der Pfad ein Link ist if ("link" == @filetype($path)) { if ("0" == ($path1 = readlink($path))) { throw new UserFormException("Can't create '$pathFileName': '$path' contains an invalid link.", ERROR_IO_INVALID_LINK); } } else { if (file_exists($path)) { if ("dir" != filetype($path)) { throw new UserFormException("Can't create '$pathFileName': There is already a file with the same name as '$path'", ERROR_IO_DIR_EXIST_AS_FILE); } } else mkdir($path, 0700); } $path .= "/"; } } /** * Convert 'false' and 'empty' to '0'. * * @param $val * * @return string */ public static function falseEmptyToZero($val) { return ($val == '' || $val == false) ? '0' : $val; } /** * Check if the string starts with the comment sign - return an empty string. * Check if the string starts with an escaped comment sign - strip the escape character. * Check if the string starts or ends with an 'escape space' - strip the escape character. * * @param string $str * * @return string */ public static function handleEscapeSpaceComment($str) { $str = trim($str); // Skip comments. if (substr($str, 0, 1) == '#') { $str = ''; // It's necessary to create an empty entry - E.g. Form.title will not exist if is a comment, but later processing expects that there is an string. } else { switch (substr($str, 0, 2)) { case '\#': case '\ ': $str = substr($str, 1); break; default: break; } if (substr($str, -1) == '\\') { $str = substr($str, 0, strlen($str) - 1); } } return $str; } /** * TODO: as soon as we don't support PHP 5.6.0 anymore, this local implemention can be removed. * Workaround for PHP < 5.6.0: there is no ldap_escape() - use this code instead. * * @param string $subject The subject string * @param string $ignore Set of characters to leave untouched * @param int $flags Any combination of LDAP_ESCAPE_* flags to indicate the * set(s) of characters to escape. * * @return string **/ public static function ldap_escape($subject, $ignore = '', $flags = 0) { if (function_exists('ldap_escape')) { return ldap_escape($subject, $ignore, $flags); } else { // define('LDAP_ESCAPE_FILTER', 0x01); // define('LDAP_ESCAPE_DN', 0x02); static $charMaps = array( LDAP_ESCAPE_FILTER => array('\\', '*', '(', ')', "\x00"), LDAP_ESCAPE_DN => array('\\', ',', '=', '+', '<', '>', ';', '"', '#'), ); // Pre-process the char maps on first call if (!isset($charMaps[0])) { $charMaps[0] = array(); for ($i = 0; $i < 256; $i++) { $charMaps[0][chr($i)] = sprintf('\\%02x', $i);; } for ($i = 0, $l = count($charMaps[LDAP_ESCAPE_FILTER]); $i < $l; $i++) { $chr = $charMaps[LDAP_ESCAPE_FILTER][$i]; unset($charMaps[LDAP_ESCAPE_FILTER][$i]); $charMaps[LDAP_ESCAPE_FILTER][$chr] = $charMaps[0][$chr]; } for ($i = 0, $l = count($charMaps[LDAP_ESCAPE_DN]); $i < $l; $i++) { $chr = $charMaps[LDAP_ESCAPE_DN][$i]; unset($charMaps[LDAP_ESCAPE_DN][$i]); $charMaps[LDAP_ESCAPE_DN][$chr] = $charMaps[0][$chr]; } } // Create the base char map to escape $flags = (int)$flags; $charMap = array(); if ($flags & LDAP_ESCAPE_FILTER) { $charMap += $charMaps[LDAP_ESCAPE_FILTER]; } if ($flags & LDAP_ESCAPE_DN) { $charMap += $charMaps[LDAP_ESCAPE_DN]; } if (!$charMap) { $charMap = $charMaps[0]; } // Remove any chars to ignore from the list $ignore = (string)$ignore; for ($i = 0, $l = strlen($ignore); $i < $l; $i++) { unset($charMap[$ignore[$i]]); } // Do the main replacement $result = strtr($subject, $charMap); // Encode leading/trailing spaces if LDAP_ESCAPE_DN is passed if ($flags & LDAP_ESCAPE_DN) { if ($result[0] === ' ') { $result = '\\20' . substr($result, 1); } if ($result[strlen($result) - 1] === ' ') { $result = substr($result, 0, -1) . '\\20'; } } return $result; } } }