+// Generate admin links for mail order
+// mailType can be: 'normal' or 'bonus'
+function generateAdminMailLinks ($mailType, $mailId) {
+ // Init variables
+ $OUT = '';
+ $table = '';
+
+ // Default column for mail status is 'data_type'
+ // @TODO Rename column data_type to e.g. mail_status
+ $statusColumn = 'data_type';
+
+ // Which mail do we have?
+ switch ($mailType) {
+ case 'bonus': // Bonus mail
+ $table = 'bonus';
+ break;
+
+ case 'normal': // Member mail
+ $table = 'pool';
+ break;
+
+ default: // Handle unsupported types
+ logDebugMessage(__FUNCTION__, __LINE__, 'Unsupported mail type ' . $mailType . ' for mailId=' . $mailId . ' detected.');
+ $OUT = '<div align="center">{%message,ADMIN_UNSUPPORTED_MAIL_TYPE_DETECTED=' . $mailType . '%}</div>';
+ break;
+ } // END - switch
+
+ // Is the mail type supported?
+ if (!empty($table)) {
+ // Query for the mail
+ $result = sqlQueryEscaped("SELECT `id`, `%s` AS `mail_status` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `id`=%s LIMIT 1",
+ array(
+ $statusColumn,
+ $table,
+ bigintval($mailId)
+ ), __FILE__, __LINE__);
+
+ // Is there one entry there?
+ if (sqlNumRows($result) == 1) {
+ // Load the entry
+ $content = sqlFetchArray($result);
+
+ // Add output and type
+ $content['type'] = $mailType;
+ $content['__output'] = '';
+
+ // Filter all data
+ $content = runFilterChain('generate_admin_mail_links', $content);
+
+ // Get output back
+ $OUT = $content['__output'];
+ } // END - if
+
+ // Free result
+ sqlFreeResult($result);
+ } // END - if
+
+ // Return generated HTML code
+ return $OUT;
+}
+
+
+/**
+ * Determine if a string can represent a number in hexadecimal
+ *
+ * @param $hex A string to check if it is hex-encoded
+ * @return $foo True if the string is a hex, otherwise false
+ * @author Marques Johansson
+ * @link http://php.net/manual/en/function.http-chunked-decode.php#89786
+ */
+function isHexadecimal ($hex) {
+ // Make it lowercase
+ $hex = strtolower(trim(ltrim($hex, '0')));
+
+ // Fix empty strings to zero
+ if (empty($hex)) {
+ $hex = 0;
+ } // END - if
+
+ // Simply compare decode->encode result with original
+ return ($hex == dechex(hexdec($hex)));
+}
+
+/**
+ * Replace chr(13) with "[r]" and PHP_EOL with "[n]" and add a final new-line to make
+ * them visible to the developer. Use this function to debug e.g. buggy HTTP
+ * response handler functions.
+ *
+ * @param $str String to overwork
+ * @return $str Overworked string
+ */
+function replaceReturnNewLine ($str) {
+ return str_replace(array(chr(13), chr(10)), array('[r]', '[n]'), $str);
+}
+
+// Converts a given string by splitting it up with given delimiter similar to
+// explode(), but appending the delimiter again
+function stringToArray ($delimiter, $string) {
+ // Init array
+ $strArray = array();
+
+ // "Walk" through all entries
+ foreach (explode($delimiter, $string) as $split) {
+ // Append the delimiter and add it to the array
+ array_push($strArray, $split . $delimiter);
+ } // END - foreach
+
+ // Return array
+ return $strArray;
+}
+
+// Detects the prefix 'mb_' if a multi-byte string is given
+function detectMultiBytePrefix ($str) {
+ // Default is without multi-byte
+ $mbPrefix = '';
+
+ // Detect multi-byte (strictly)
+ if (mb_detect_encoding($str, 'auto', TRUE) !== FALSE) {
+ // With multi-byte encoded string
+ $mbPrefix = 'mb_';
+ } // END - if
+
+ // Return the prefix
+ return $mbPrefix;
+}
+
+// Searches given array for a sub-string match and returns all found keys in an array
+function getArrayKeysFromSubStrArray ($heystack, $needles, $offset = 0) {
+ // Init array for all found keys
+ $keys = array();
+
+ // Now check all entries
+ foreach ($needles as $key => $needle) {
+ // Is there found a partial string?
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'heystack='.$heystack.',key='.$key.',needle='.$needle.',offset='.$offset);
+ if (strpos($heystack, $needle, $offset) !== FALSE) {
+ // Add the found key
+ array_push($keys, $key);
+ } // END - if
+ } // END - foreach
+
+ // Return the array
+ return $keys;
+}
+
+// Determines database column name from given subject and locked
+function determinePointsColumnFromSubjectLocked ($subject, $locked) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ' - ENTERED!');
+ // Default is 'normal' points
+ $pointsColumn = 'points';
+
+ // Which points, locked or normal?
+ if ($locked === TRUE) {
+ $pointsColumn = 'locked_points';
+ } // END - if
+
+ // Prepare array for filter
+ $filterData = array(
+ 'subject' => $subject,
+ 'locked' => $locked,
+ 'column' => $pointsColumn
+ );
+
+ // Run the filter
+ $filterData = runFilterChain('determine_points_column_name', $filterData);
+
+ // Extract column name from array
+ $pointsColumn = $filterData['column'];
+
+ // Return it
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ',pointsColumn=' . $pointsColumn . ' - EXIT!');
+ return $pointsColumn;
+}
+
+// Converts a boolean variable into 'Y' for true and 'N' for false
+function convertBooleanToYesNo ($boolean) {
+ // Default is 'N'
+ $converted = 'N';
+ if ($boolean === TRUE) {
+ // Set 'Y'
+ $converted = 'Y';
+ } // END - if
+
+ // Return it
+ return $converted;
+}
+
+// "Translates" 'true' to true and 'false' to false
+function convertStringToBoolean ($str) {
+ // Debug message (to measure how often this function is called)
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'str=' . $str);
+
+ // Is there cache?
+ if (!isset($GLOBALS[__FUNCTION__][$str])) {
+ // Trim it lower-case for validation
+ $strTrimmed = trim(strtolower($str));
+
+ // Is it valid?
+ if (!in_array($strTrimmed, array('true', 'false'))) {
+ // Not valid!
+ reportBug(__FUNCTION__, __LINE__, 'str=' . $str . '(' . $strTrimmed . ') is not true/false');
+ } // END - if
+
+ // Determine it
+ $GLOBALS[__FUNCTION__][$str] = ($strTrimmed == 'true');
+ } // END - if
+
+ // Return cache
+ return $GLOBALS[__FUNCTION__][$str];
+}
+
+/**
+ * "Makes" a variable in given string parseable, this function will throw an
+ * error if the first character is not a dollar sign.
+ *
+ * @param $varString String which contains a variable
+ * @return $return String with added single quotes for better parsing
+ */
+function makeParseableVariable ($varString) {
+ // The first character must be a dollar sign
+ if (substr($varString, 0, 1) != '$') {
+ // Please report this
+ reportBug(__FUNCTION__, __LINE__, 'varString=' . $varString . ' - No dollar sign detected, will not parse it.');
+ } // END - if
+
+ // Is there cache?
+ if (!isset($GLOBALS[__FUNCTION__][$varString])) {
+ // Snap them in, if [,] are there
+ $GLOBALS[__FUNCTION__][$varString] = str_replace(array('[', ']'), array("['", "']"), $varString);
+ } // END - if
+
+ // Return cache
+ return $GLOBALS[__FUNCTION__][$varString];
+}
+
+// "Getter" for random TAN
+function getRandomTan () {
+ // Generate one
+ return mt_rand(0, 99999);
+}
+
+// Removes any : from subject
+function removeDoubleDotFromSubject ($subject) {
+ // Remove it
+ $subjectArray = explode(':', $subject);
+ $subject = $subjectArray[0];
+ unset($subjectArray);
+
+ // Return it
+ return $subject;
+}
+
+// Adds a given entry to the database
+function memberAddEntries ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $timeColumns = array(), $columnIndex = NULL) {
+ // Is it a member?
+ if (!isMember()) {
+ // Then abort here
+ return FALSE;
+ } // END - if
+
+ // Set POST data generic userid
+ setPostRequestElement('userid', getMemberId());
+
+ // Call inner function
+ doGenericAddEntries($tableName, $columns, $filterFunctions, $extraValues, $timeColumns, $columnIndex);
+
+ // Entry has been added?
+ if ((!ifSqlHasZeroAffectedRows()) && ($GLOBALS['__XML_PARSE_RESULT'] === TRUE)) {
+ // Display success message
+ displayMessage('{--MEMBER_ENTRY_ADDED--}');
+ } else {
+ // Display failed message
+ displayMessage('{--MEMBER_ENTRY_NOT_ADDED--}');
+ }
+}
+
+// Edit rows by given id numbers
+function memberEditEntriesConfirm ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $timeColumns = array(), $editNow = array(FALSE), $idColumn = array('id'), $userIdColumn = array('userid'), $rawUserId = array('userid'), $cacheFiles = array(), $content = array()) {
+ // $tableName must be an array
+ if ((!is_array($tableName)) || (count($tableName) != 1)) {
+ // No tableName specified
+ reportBug(__FUNCTION__, __LINE__, 'tableName is not given. Please fix your XML,tableName[]=' . gettype($tableName) . '!=array: userIdColumn=' . $userIdColumn);
+ } elseif (!is_array($idColumn)) {
+ // $idColumn is no array
+ reportBug(__FUNCTION__, __LINE__, 'idColumn[]=' . gettype($idColumn) . '!=array: userIdColumn=' . $userIdColumn);
+ } elseif (!is_array($userIdColumn)) {
+ // $userIdColumn is no array
+ reportBug(__FUNCTION__, __LINE__, 'userIdColumn[]=' . gettype($userIdColumn) . '!=array: userIdColumn=' . $userIdColumn);
+ } elseif (!is_array($editNow)) {
+ // $editNow is no array
+ reportBug(__FUNCTION__, __LINE__, 'editNow[]=' . gettype($editNow) . '!=array: userIdColumn=' . $userIdColumn);
+ } // END - if
+
+ // Shall we change here or list for editing?
+ if ($editNow[0] === TRUE) {
+ // Add generic userid field
+ setPostRequestElement('userid', getMemberId());
+
+ // Call generic change method
+ $affected = doGenericEditEntriesConfirm($tableName, $columns, $filterFunctions, $extraValues, $timeColumns, $editNow, $idColumn, $userIdColumn, $rawUserId, $cacheFiles, 'mem_edit');
+
+ // Was this fine?
+ if ($affected == countPostSelection($idColumn[0])) {
+ // All deleted
+ displayMessage('{--MEMBER_ALL_ENTRIES_EDITED--}');
+ } else {
+ // Some are still there :(
+ displayMessage(sprintf(getMessage('MEMBER_SOME_ENTRIES_NOT_EDITED'), $affected, countPostSelection($idColumn[0])));
+ }
+ } else {
+ // List for editing
+ memberListBuilder('edit', $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId, $content);
+ }
+}
+
+// Delete rows by given id numbers
+function memberDeleteEntriesConfirm ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $deleteNow = array(FALSE), $idColumn = array('id'), $userIdColumn = array('userid'), $rawUserId = array('userid'), $cacheFiles = array(), $content = array()) {
+ // Do this only for members
+ assert(isMember(), 'isMember()=false which is not expected.');
+
+ // $tableName must be an array
+ if ((!is_array($tableName)) || (count($tableName) != 1)) {
+ // No tableName specified
+ reportBug(__FUNCTION__, __LINE__, 'tableName is not given. Please fix your XML,tableName[]=' . gettype($tableName) . '!=array: userIdColumn=' . $userIdColumn);
+ } elseif (!is_array($idColumn)) {
+ // $idColumn is no array
+ reportBug(__FUNCTION__, __LINE__, 'idColumn[]=' . gettype($idColumn) . '!=array: userIdColumn=' . $userIdColumn);
+ } elseif (!is_array($userIdColumn)) {
+ // $userIdColumn is no array
+ reportBug(__FUNCTION__, __LINE__, 'userIdColumn[]=' . gettype($userIdColumn) . '!=array: userIdColumn=' . $userIdColumn);
+ } elseif (!is_array($deleteNow)) {
+ // $deleteNow is no array
+ reportBug(__FUNCTION__, __LINE__, 'deleteNow[]=' . gettype($deleteNow) . '!=array: userIdColumn=' . $userIdColumn);
+ } // END - if
+
+ // Shall we delete here or list for deletion?
+ if ($deleteNow[0] === TRUE) {
+ // Add generic userid field
+ setPostRequestElement('userid', getMemberId());
+
+ // Call generic function
+ $affected = doGenericDeleteEntriesConfirm($tableName, $columns, $filterFunctions, $extraValues, $deleteNow, $idColumn, $userIdColumn, $rawUserId, $cacheFiles, 'mem_delete');
+
+ // Was this fine?
+ if ($affected == countPostSelection($idColumn[0])) {
+ // All deleted
+ displayMessage('{--MEMBER_ALL_ENTRIES_REMOVED--}');
+ } else {
+ // Some are still there :(
+ displayMessage(sprintf(getMessage('MEMBER_SOME_ENTRIES_NOT_DELETED'), sqlAffectedRows(), countPostSelection($idColumn[0])));
+ }
+ } else {
+ // List for deletion confirmation
+ memberListBuilder('delete', $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUSerId, $content);
+ }
+}
+
+// Build a special template list
+// @TODO cacheFiles is not yet supported
+function memberListBuilder ($listType, $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId = array('userid'), $content = array()) {
+ // Do this only for logged in member
+ assert(isMember(), 'isMember()=false which is not expected.');
+
+ // Call inner (general) function
+ doGenericListBuilder('member', $listType, $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId, $content);
+}
+
+// Checks whether given address is IPv4
+function isIp4AddressValid ($address) {
+ // Is there cache?
+ if (!isset($GLOBALS[__FUNCTION__][$address])) {
+ // Determine it ...
+ $GLOBALS[__FUNCTION__][$address] = preg_match('/((25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9])\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[0-9]))/', $address);
+ } // END - if
+
+ // Return cache
+ return $GLOBALS[__FUNCTION__][$address];
+}
+
+// Returns the string if not empty or FALSE if empty
+function validateIsEmpty ($str) {
+ // Trim it
+ $trimmed = trim($str);
+
+ // Is the string empty?
+ if (empty($trimmed)) {
+ // Then set FALSE
+ $str = FALSE;
+ } // END - if
+
+ // Return it
+ return $str;
+}
+
+// "Getter" for seconds from given time unit
+function getSecondsFromTimeUnit ($timeUnit) {
+ // Default is not found
+ $seconds = NULL;
+
+ // "Detect" it
+ switch ($timeUnit) {
+ case 's': // Seconds = 1
+ $seconds = 1;
+ break;
+
+ case 'm': // Minutes
+ $seconds = 60;
+ break;
+
+ case 'h': // Hours
+ $seconds = 60*60;
+ break;
+
+ case 'D': // Days
+ $seconds = 60*60*24;
+ break;
+
+ case 'W': // Weeks
+ $seconds = 60*60*24*7;
+ break;
+
+ default: // Unsupported
+ reportBug(__FUNCTION__, __LINE__, 'Unsupported time unit ' . $timeUnit . ' detected.');
+ break;
+ } // END - switch
+
+ // Return value
+ return $seconds;
+}
+
+// Calulates value for given seconds and time unit
+function caluculateTimeUnitValue ($seconds, $timeUnit) {
+ // Calculate it
+ return ($seconds / getSecondsFromTimeUnit($timeUnit));
+}
+
+// "Getter" for an array from given one but only one index of it
+function getArrayFromArrayIndex ($array, $key) {
+ // Some simple validation
+ assert(isset($array[0][$key]), 'array[0][' . $key . '] is not set.');
+
+ // Init new array
+ $newArray = array();
+
+ // "Walk" through all elements
+ foreach ($array as $element) {
+ $newArray[] = $element[$key];
+ } // END - if
+
+ // Return it
+ return $newArray;
+}
+
+/**
+ * Compress given data and encodes it into BASE64 to be stored in database with
+ * sqlQueryEscaped()
+ *
+ * @param $data Data to be compressed and encoded
+ * @return $data Compressed+encoded data
+ */
+function compress ($data) {
+ // Compress it
+ return base64_encode(gzcompress($data));
+}
+
+/**
+ * Decompress given data previously compressed with compress().
+ *
+ * @param $data Data compressed with compress()
+ * @reurn $data Uncompressed data
+ */
+function decompress ($data) {
+ // Decompress it
+ return gzuncompress(base64_decode($data));
+}
+
+/**
+ * Converts given charset in given string to UTF-8 if not UTF-8. This function
+ * is currently limited to iconv().
+ *
+ * @param $str String to convert charset in
+ * @param $charset Charset to convert from
+ * @return $str Converted string
+ */
+function convertCharsetToUtf8 ($str, $charset) {
+ // Is iconv() available?
+ if (!function_exists('iconv')) {
+ // Please make it sure
+ reportBug(__FUNCTION__, __LINE__, 'PHP function iconv() is currently required to do charset convertion.');
+ } // END - if
+
+ // Is the charset not UTF-8?
+ if (strtoupper($charset) != 'UTF-8') {
+ // Convert it to UTF-8
+ $str = iconv(strtoupper($charset), 'UTF-8//TRANSLIT', $str);
+ } // END - if
+
+ // Return converted string
+ return $str;
+}
+
+// Hash string with SHA256 and encode it to hex
+function hashSha256 ($str) {
+ /// Hash string
+ $hash = mhash(MHASH_SHA256, $str);
+
+ // Encode it to hexadecimal
+ $hex = '';
+ for ($i = 0; $i < strlen($hash); $i++) {
+ // Encode char to decimal, pad it with zero, add it
+ $hex .= padLeftZero(dechex(ord(substr($hash, $i, 1))));
+ } // END - if
+
+ // Return it
+ return $hex;
+}
+
+// ----------------------------------------------------------------------------
+// "Translatation" functions for points_data table
+// ----------------------------------------------------------------------------
+
+// Translates generically some data into a target string
+function translateGeneric ($messagePrefix, $data, $messageSuffix = '') {
+ // Is the method null or empty?
+ if (is_null($data)) {
+ // Is NULL
+ $data = 'NULL';
+ } elseif (empty($data)) {
+ // Is empty (string)
+ $data = 'EMPTY';
+ } // END - if
+
+ // Default column name is unknown
+ $return = '{%message,' . $messagePrefix . '_UNKNOWN' . $messageSuffix . '=' . strtoupper($data) . '%}';
+
+ // Construct message id
+ $messageId = $messagePrefix . '_' . strtoupper($data) . $messageSuffix;
+
+ // Is it there?
+ if (isMessageIdValid($messageId)) {
+ // Then use it as message string
+ $return = '{--' . $messageId . '--}';
+ } // END - if
+
+ // Return the column name
+ return $return;
+}
+
+// Translates points subject to human-readable
+function translatePointsSubject ($subject) {
+ // Remove any :x
+ $subject = removeDoubleDotFromSubject($subject);
+
+ // Return it
+ return translateGeneric('POINTS_SUBJECT', $subject);
+}
+
+// "Translates" given points account type
+function translatePointsAccountType ($accountType) {
+ // Return it
+ return translateGeneric('POINTS_ACCOUNT_TYPE', $accountType);
+}
+
+// "Translates" given points "locked mode"
+function translatePointsLockedMode ($lockedMode) {
+ // Return it
+ return translateGeneric('POINTS_LOCKED_MODE', $lockedMode);
+}
+
+// "Translates" given points payment method
+function translatePointsPaymentMethod ($paymentMethod) {
+ // Return it
+ return translateGeneric('POINTS_PAYMENT_METHOD', $paymentMethod);
+}
+
+// "Translates" given points account provider
+function translatePointsAccountProvider ($accountProvider) {
+ // Return it
+ return translateGeneric('POINTS_ACCOUNT_PROVIDER', $accountProvider);
+}
+
+// "Translates" given points notify recipient
+function translatePointsNotifyRecipient ($notifyRecipient) {
+ // Return it
+ return translateGeneric('POINTS_NOTIFY_RECIPIENT', $notifyRecipient);
+}
+
+// "Translates" given mode to a human-readable version
+function translatePointsMode ($pointsMode) {
+ // Return it
+ return translateGeneric('POINTS_MODE', $pointsMode);
+}
+
+// "Translates" task type to a human-readable version
+function translateTaskType ($taskType) {
+ // Return it
+ return translateGeneric('ADMIN_TASK_TYPE', $taskType);
+}
+
+// "Translates" task status to a human-readable version
+function translateTaskStatus ($taskStatus) {
+ // Return it
+ return translateGeneric('ADMIN_TASK_STATUS', $taskStatus);
+}
+
+/*
+ *-----------------------------------------------------------------------------
+ * Automatically re-created functions, all taken from user comments on
+ * www.php.net
+ *-----------------------------------------------------------------------------
+ */