6) || (empty($img_code)) || (getConfig('code_length') == '0')) {
+ if ((strlen($img_code) > 6) || (empty($img_code)) || (getCodeLength() == '0')) {
// Stop execution of function here because of over-sized code length
- debug_report_bug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getConfig('code_length'));
- } elseif ($headerSent === false) {
+ reportBug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code(length)=' . strlen($img_code) . ' code_length=' . getCodeLength());
+ } elseif ($headerSent === FALSE) {
// Return an HTML code here
return ' ';
}
// Load image
- $img = sprintf("%s/theme/%s/images/code_bg.%s",
+ $img = sprintf('%s/theme/%s/images/code_bg.%s',
getPath(),
getCurrentTheme(),
- getConfig('img_type')
+ getImgType()
);
// Is it readable?
if (isFileReadable($img)) {
// Switch image type
- switch (getConfig('img_type')) {
- case 'jpg':
- // Okay, load image and hide all errors
+ switch (getImgType()) {
+ case 'jpg': // Okay, load image and hide all errors
$image = imagecreatefromjpeg($img);
break;
- case 'png':
- // Okay, load image and hide all errors
+ case 'png': // Okay, load image and hide all errors
$image = imagecreatefrompng($img);
break;
} // END - switch
} else {
- // Exit function here
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image type %s not found.", getConfig('img_type')));
+ // Silently log the error
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('File for image-type %s in theme %s not found.', getImgType(), getCurrentTheme()));
return;
}
@@ -825,10 +956,10 @@ function generateImageOrCode ($img_code, $headerSent = true) {
imagestring($image, 5, 14, 2, $img_code, $text_color);
// Return to browser
- sendHeader('Content-Type: image/' . getConfig('img_type'));
+ setContentType('image/' . getImgType());
// Output image with matching image factory
- switch (getConfig('img_type')) {
+ switch (getImgType()) {
case 'jpg': imagejpeg($image); break;
case 'png': imagepng($image); break;
} // END - switch
@@ -836,216 +967,150 @@ function generateImageOrCode ($img_code, $headerSent = true) {
// Remove image from memory
imagedestroy($image);
}
+
// Create selection box or array of splitted timestamp
-function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
+function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $asArray = FALSE, $allSteps = FALSE) {
// Do not continue if ONE_DAY is absend
if (!isConfigEntrySet('ONE_DAY')) {
- // And return the timestamp itself or empty array
- if ($return_array === true) {
- return array();
- } else {
- return $timestamp;
- }
+ // Abort here
+ reportBug(__FUNCTION__, __LINE__, 'Configuration entry ONE_DAY is absend. timestamp=' . $timestamp . ',prefix=' . $prefix . ',align=' . $align . ',asArray=' . intval($asArray));
} // END - if
// Calculate 2-seconds timestamp
$stamp = round($timestamp);
//* DEBUG: */ debugOutput('*' . $stamp .'/' . $timestamp . '*');
- // Do we have a leap year?
+ // Is there a leap year?
$SWITCH = '0';
$TEST = getYear() / 4;
$M1 = getMonth();
$M2 = getMonth(time() + $timestamp);
// If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
- if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02')) $SWITCH = getConfig('ONE_DAY');
+ if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02')) {
+ $SWITCH = getOneDay();
+ } // END - switch
// First of all years...
- $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
- //* DEBUG: */ debugOutput('Y=' . $Y);
+ $year = abs(floor($timestamp / (31536000 + $SWITCH)));
+ //* DEBUG: */ debugOutput('year=' . $year);
// Next months...
- $M = abs(floor($timestamp / 2628000 - $Y * 12));
- //* DEBUG: */ debugOutput('M=' . $M);
+ $month = abs(floor($timestamp / 2628000 - $year * 12));
+ //* DEBUG: */ debugOutput('month=' . $month);
// Next weeks
- $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getConfig('ONE_DAY')) / 7) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) / 7)));
- //* DEBUG: */ debugOutput('W=' . $W);
+ $week = abs(floor($timestamp / 604800 - $year * ((365 + $SWITCH / getOneDay()) / 7) - ($month / 12 * (365 + $SWITCH / getOneDay()) / 7)));
+ //* DEBUG: */ debugOutput('week=' . $week);
// Next days...
- $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY'))) - $W * 7));
- //* DEBUG: */ debugOutput('D=' . $D);
+ $day = abs(floor($timestamp / 86400 - $year * (365 + $SWITCH / getOneDay()) - ($month / 12 * (365 + $SWITCH / getOneDay())) - $week * 7));
+ //* DEBUG: */ debugOutput('day=' . $day);
// Next hours...
- $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24) - $W * 7 * 24 - $D * 24));
- //* DEBUG: */ debugOutput('h=' . $h);
+ $hour = abs(floor($timestamp / 3600 - $year * (365 + $SWITCH / getOneDay()) * 24 - ($month / 12 * (365 + $SWITCH / getOneDay()) * 24) - $week * 7 * 24 - $day * 24));
+ //* DEBUG: */ debugOutput('hour=' . $hour);
// Next minutes..
- $m = abs(floor($timestamp / 60 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 60 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 60) - $W * 7 * 24 * 60 - $D * 24 * 60 - $h * 60));
- //* DEBUG: */ debugOutput('m=' . $m);
+ $minute = abs(floor($timestamp / 60 - $year * (365 + $SWITCH / getOneDay()) * 24 * 60 - ($month / 12 * (365 + $SWITCH / getOneDay()) * 24 * 60) - $week * 7 * 24 * 60 - $day * 24 * 60 - $hour * 60));
+ //* DEBUG: */ debugOutput('minute=' . $minute);
// And at last seconds...
- $s = abs(floor($timestamp - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 3600 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 3600) - $W * 7 * 24 * 3600 - $D * 24 * 3600 - $h * 3600 - $m * 60));
- //* DEBUG: */ debugOutput('s=' . $s);
+ $second = abs(floor($timestamp - $year * (365 + $SWITCH / getOneDay()) * 24 * 3600 - ($month / 12 * (365 + $SWITCH / getOneDay()) * 24 * 3600) - $week * 7 * 24 * 3600 - $day * 24 * 3600 - $hour * 3600 - $minute * 60));
+ //* DEBUG: */ debugOutput('second=' . $second);
// Is seconds zero and time is < 60 seconds?
- if (($s == '0') && ($timestamp < 60)) {
+ if (($second < 1) && ($timestamp < 60)) {
// Fix seconds
- $s = round($timestamp);
+ $second = round($timestamp);
} // END - if
+ // Put all calculated values in array
+ $data = array(
+ 'Y' => $year,
+ 'M' => $month,
+ 'W' => $week,
+ 'D' => $day,
+ 'h' => $hour,
+ 'm' => $minute,
+ 's' => $second
+ );
+
//
// Now we convert them in seconds...
//
- if ($return_array) {
- // Just put all data in an array for later use
- $OUT = array(
- 'YEARS' => $Y,
- 'MONTHS' => $M,
- 'WEEKS' => $W,
- 'DAYS' => $D,
- 'HOURS' => $h,
- 'MINUTES' => $m,
- 'SECONDS' => $s
- );
+ if ($asArray === TRUE) {
+ // Just put data array out
+ $OUT = $data;
} else {
+ // Init array
+ $units = array(
+ // Time unit -> field name
+ 'unit_field' => array(
+ 'Y' => 'ye',
+ 'M' => 'mn',
+ 'W' => 'we',
+ 'D' => 'da',
+ 'h' => 'ho',
+ 'm' => 'mi',
+ 's' => 'se'
+ ),
+ // Time unit -> label
+ 'unit_label' => array(
+ 'Y' => 'YEAR',
+ 'M' => 'MONTH',
+ 'W' => 'WEEK',
+ 'D' => 'DAY',
+ 'h' => 'HOUR',
+ 'm' => 'MINUTE',
+ 's' => 'SECOND'
+ )
+ );
+
// Generate table
$OUT = '';
$OUT .= '
';
$OUT .= '';
- if (isInString('Y', $display) || (empty($display))) {
- $OUT .= '{--_YEARS--}
';
- } // END - if
-
- if (isInString('M', $display) || (empty($display))) {
- $OUT .= '{--_MONTHS--}
';
- } // END - if
-
- if (isInString('W', $display) || (empty($display))) {
- $OUT .= '{--_WEEKS--}
';
- } // END - if
-
- if (isInString('D', $display) || (empty($display))) {
- $OUT .= '{--_DAYS--}
';
- } // END - if
-
- if (isInString('h', $display) || (empty($display))) {
- $OUT .= '{--_HOURS--}
';
- } // END - if
-
- if (isInString('m', $display) || (empty($display))) {
- $OUT .= '{--_MINUTES--}
';
- } // END - if
-
- if (isInString('s', $display) || (empty($display))) {
- $OUT .= '{--_SECONDS--}
';
- } // END - if
+ // "Walk" through all units
+ foreach ($units['unit_field'] as $unit => $field) {
+ // Is this displayed or zero?
+ if (isInString($unit, $display) || (empty($display))) {
+ // @TODO not working here
+ $OUT .= '{--TIME_UNIT_' . $units['unit_label'][$unit] . '--}
';
+ } // END - if
+ } // END - foreach
+ // Close table row and open new one
$OUT .= ' ';
$OUT .= '';
- if (isInString('Y', $display) || (empty($display))) {
- // Generate year selection
- $OUT .= '';
- for ($idx = 0; $idx <= 10; $idx++) {
- $OUT .= '';
- } // END - for
- $OUT .= ' ';
- } else {
- $OUT .= ' ';
- }
-
- if (isInString('M', $display) || (empty($display))) {
- // Generate month selection
- $OUT .= '';
- for ($idx = 0; $idx <= 11; $idx++) {
- $OUT .= ' ';
- } // END - for
- $OUT .= ' ';
- } else {
- $OUT .= ' ';
- }
-
- if (isInString('W', $display) || (empty($display))) {
- // Generate week selection
- $OUT .= '';
- for ($idx = 0; $idx <= 4; $idx++) {
- $OUT .= ' ';
- } // END - for
- $OUT .= ' ';
- } else {
- $OUT .= ' ';
- }
-
- if (isInString('D', $display) || (empty($display))) {
- // Generate day selection
- $OUT .= '';
- for ($idx = 0; $idx <= 31; $idx++) {
- $OUT .= ' ';
- } // END - for
- $OUT .= ' ';
- } else {
- $OUT .= ' ';
- }
-
- if (isInString('h', $display) || (empty($display))) {
- // Generate hour selection
- $OUT .= '';
- for ($idx = 0; $idx <= 23; $idx++) {
- $OUT .= ' ';
- } // END - for
- $OUT .= ' ';
- } else {
- $OUT .= ' ';
- }
-
- if (isInString('m', $display) || (empty($display))) {
- // Generate minute selection
- $OUT .= '';
- for ($idx = 0; $idx <= 59; $idx++) {
- $OUT .= ' ';
- } // END - for
- $OUT .= ' ';
- } else {
- $OUT .= ' ';
- }
+ // "Walk" through all units again
+ foreach ($units['unit_field'] as $unit => $field) {
+ // Is this used?
+ if (isInString($unit, $display) || (empty($display))) {
+ // Generate year selection
+ $OUT .= '';
+ $OUT .= addSelectionBox($field, $data[$unit], $prefix, NULL, 'mini_select', $allSteps);
+ $OUT .= ' ';
+ } else {
+ $OUT .= ' ';
+ }
+ } // END - foreach
- if (isInString('s', $display) || (empty($display))) {
- // Generate second selection
- $OUT .= '';
- for ($idx = 0; $idx <= 59; $idx++) {
- $OUT .= ' ';
- } // END - for
- $OUT .= ' ';
- } else {
- $OUT .= ' ';
- }
+ // Close all tags
$OUT .= ' ';
$OUT .= '
';
$OUT .= '
';
}
- // Return generated HTML code
+ // Return generated HTML code or data array
return $OUT;
}
// Generate a list of administrative links to a given userid
function generateMemberAdminActionLinks ($userid) {
// Make sure userid is a number
- if ($userid != bigintval($userid)) debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
+ if ($userid != bigintval($userid)) {
+ reportBug(__FUNCTION__, __LINE__, 'userid is not a number!');
+ } // END - if
// Define all main targets
- $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
+ $targetArray = runFilterChain('member_admin_actions', array('del_user', 'edit_user', 'lock_user', 'list_refs', 'list_links', 'add_points', 'sub_points'));
// Get user status
$status = getFetchedUserData('userid', $userid, 'status');
@@ -1053,27 +1118,39 @@ function generateMemberAdminActionLinks ($userid) {
// Begin of navigation links
$OUT = '[';
- foreach ($targetArray as $tar) {
- $OUT .= '{--ADMIN_';
- if (($tar == 'lock_user') && ($status == 'LOCKED')) {
+ $OUT .= '_TITLE--}">{--ADMIN_USER_ACTION_LINK_';
+ if (($target == 'lock_user') && ($status == 'LOCKED')) {
// Locked accounts shall be unlocked
$OUT .= 'UNLOCK_USER';
+ } elseif ($target == 'del_user') {
+ // @TODO Deprecate this thing
+ $OUT .= 'DELETE_USER';
} else {
// All other status is fine
- $OUT .= strtoupper($tar);
+ $OUT .= strtoupper($target);
}
$OUT .= '--} |';
} // END - foreach
+ // Add special link, in case of the account is unconfirmed
+ if ($status == 'UNCONFIRMED') {
+ // Add it
+ $OUT .= '{--ADMIN_USER_ACTION_LINK_CONFIRM_ACCOUNT--} |';
+ } // END - if
+
// Finish navigation link
$OUT = substr($OUT, 0, -1) . ']';
@@ -1092,62 +1169,93 @@ function generateEmailLink ($email, $table = 'admins') {
$EMAIL = generateAdminEmailLink($email);
} elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
// Create email link for contacting a member within admin area (or later in other areas, too?)
- $EMAIL = generateUserEmailLink($email, 'admin');
+ $EMAIL = generateUserEmailLink($email);
} elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
// Create email link to contact sponsor within admin area (or like the link above?)
- $EMAIL = generateSponsorEmailLink($email, 'sponsor_data');
+ $EMAIL = generateSponsorEmailLink($email);
}
- // Shall I close the link when there is no admin?
- if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
-
// Return email link
return $EMAIL;
}
-// Output error messages in a fasioned way and die...
-function app_die ($F, $L, $message) {
+/**
+ * Outputs an error message in a "fashioned way" to the user, by putting it into
+ * a nice looking web page, if one of HTML or CSS output mode is active.
+ *
+ * Please use reportBug() instead of this function. reportBug() has more helpful
+ * functionality like logging and admin notification (which you can configure
+ * through your admin area).
+ *
+ * @param $file Function or file basename where the error came from
+ * @param $line Line number where the error came from
+ * @param $message Message which shall be output to web
+ * @return void
+ */
+function app_exit ($file, $line, $message) {
// Check if Script is already dieing and not let it kill itself another 1000 times
- if (!isset($GLOBALS['app_died'])) {
- // Make sure, that the script realy realy diese here and now
- $GLOBALS['app_died'] = true;
+ if (isset($GLOBALS['app_died'])) {
+ // Script tried to kill itself twice
+ die('[' . __FUNCTION__ . ':' . __LINE__ . ']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $file . ', line=' . $line);
+ } // END - if
+
+ // Make sure, that the script realy realy diese here and now
+ $GLOBALS['app_died'] = TRUE;
+ // Is this AJAX mode?
+ if (isAjaxOutputMode()) {
+ // Set content type as application/json
+ setContentType('application/json');
+ } else {
// Set content type as text/html
setContentType('text/html');
+ }
- // Load header
- loadIncludeOnce('inc/header.php');
+ // Load header
+ loadPageHeader();
- // Rewrite message for output
- $message = sprintf(getMessage('MAILER_HAS_DIED'), basename($F), $L, $message);
+ // Rewrite message for output
+ $message = sprintf(
+ getMessage('MAILER_HAS_DIED'),
+ basename($file),
+ $line,
+ $message
+ );
+ // Is this AJAX mode again
+ if (isAjaxOutputMode()) {
// Load the message template
- loadTemplate('app_die_message', false, $message);
+ $OUT = loadTemplate('ajax_app_exit_message', TRUE, $message);
- // Load footer
- loadIncludeOnce('inc/footer.php');
+ // Output it as JSON encoded
+ outputHtml(encodeJson(array('reply_content' => urlencode(doFinalCompilation(compileRawCode($OUT))))));
} else {
- // Script tried to kill itself twice
- die('['.__FUNCTION__.':'.__LINE__.']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
+ // Load the message template
+ loadTemplate('app_exit_message', FALSE, $message);
}
+
+ // Load footer
+ loadPageFooter();
}
// Display parsing time and number of SQL queries in footer
function displayParsingTime () {
// Is the timer started?
- if (!isset($GLOBALS['startTime'])) {
+ if (!isset($GLOBALS['__start_time'])) {
// Abort here
- return false;
+ return FALSE;
} // END - if
// Get end time
- $endTime = microtime(true);
+ $endTime = microtime(TRUE);
// "Explode" both times
- $start = explode(' ', $GLOBALS['startTime']);
+ $start = explode(' ', $GLOBALS['__start_time']);
$end = explode(' ', $endTime);
$runTime = $end[0] - $start[0];
- if ($runTime < 0) $runTime = '0';
+ if ($runTime < 0) {
+ $runTime = '0';
+ } // END - if
// Prepare output
// @TODO This can be easily moved out after the merge from EL branch to this is complete
@@ -1157,21 +1265,43 @@ function displayParsingTime () {
);
// Load the template
- $GLOBALS['page_footer'] .= loadTemplate('show_timings', true, $content);
+ $GLOBALS['__page_footer'] .= loadTemplate('show_timings', TRUE, $content);
+
+ // Is debug enabled?
+ if (isDebugModeEnabled()) {
+ // Log loading of total includes
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Loaded includes: ' . count($GLOBALS['inc_loaded']) . ', readable files: ' . count($GLOBALS['file_readable']));
+ } // END - if
}
-// Output a debug backtrace to the user
-function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
+/**
+ * Outputs an error message and backtrace to the user, by default a mail with
+ * all relevant data is being mailed to the configured administrators.
+ *
+ * This function shall be used "publicly" because of logging, admin notification
+ * and double-call prevention (see first if() block) instead of app_exit().
+ * app_exit() is more a "private" function and will only output a bug message to
+ * the user, no email and no logging.
+ *
+ * @param $file Function or file basename where the error came from
+ * @param $line Line number where the error came from
+ * @param $sendEmail Wether to send an email to all configured administrators
+ * @return void
+ */
+function reportBug ($file, $line, $message = '', $sendEmail = TRUE) {
// Is this already called?
if (isset($GLOBALS[__FUNCTION__])) {
// Other backtrace
- print 'Message:'.$message.' Backtrace:';
+ print '[' . $file . ':' . $line . ':] ' . __FUNCTION__ . '() has already died! Message:' . $message . ' Backtrace:';
debug_print_backtrace();
die(' ');
} // END - if
- // Set this function as called
- $GLOBALS[__FUNCTION__] = true;
+ // Set HTTP status to 500 (e.g. for AJAX requests)
+ setHttpStatus('500 Internal Server Error');
+
+ // Mark this function as called
+ $GLOBALS[__FUNCTION__] = TRUE;
// Init message
$debug = '';
@@ -1184,18 +1314,18 @@ function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
);
// @TODO Add a little more infos here
- logDebugMessage($F, $L, strip_tags($message));
+ logDebugMessage($file, $line, strip_tags($message));
} // END - if
// Add output
- $debug .= 'Please report this bug at http://bugs.mxchange.org and include the logfile from ' . str_replace(getPath(), '', getCachePath()) . 'debug.log in your report (you can now attach files):';
+ $debug .= 'Please report this bug at http://bugs.mxchange.org and include this whole message + logfile from ' . str_replace(getPath(), '', getCachePath()) . 'debug.log in your report (you can now attach files). Backtrace:';
$debug .= debug_get_printable_backtrace();
$debug .= ' ';
- $debug .= 'Request-URI: ' . getRequestUri() . '
';
- $debug .= 'Thank you for finding bugs.
';
+ $debug .= 'Request-URI: ' . getRequestUri() . '
';
+ $debug .= 'Thank you for finding bugs.
';
// Send an email? (e.g. not wanted for evaluation errors)
- if (($sendEmail === true) && (!isInstallationPhase())) {
+ if (($sendEmail === TRUE) && (!isInstaller()) && (isAdminRegistered())) {
// Prepare content
$content = array(
'message' => trim($message),
@@ -1203,30 +1333,86 @@ function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
);
// Send email to webmaster
- sendAdminNotification('{--DEBUG_REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
+ sendAdminNotification('{--REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
} // END - if
- // And abort here
- app_die($F, $L, $debug);
+ // Is there HTML/CSS/AJAX mode while debug-mode is enabled?
+ if (((isDebugModeEnabled()) || (isInstaller())) && ((isHtmlOutputMode()) || (isCssOutputMode()) || (isAjaxOutputMode()))) {
+ // And abort here
+ app_exit($file, $line, $debug);
+ } elseif (isAjaxOutputMode()) {
+ // Load include (again?)
+ loadIncludeOnce('inc/ajax-functions.php');
+
+ // Init AJAX
+ initAjax();
+
+ // Set HTTP status to 500 again
+ setHttpStatus('500 Internal Server Error');
+
+ // Is AJAX output mode, then output message as JSON
+ setAjaxReplyContent($debug);
+
+ // Send it out to browser
+ sendAjaxContent(TRUE);
+
+ // Include footer
+ loadPageFooter();
+ } else {
+ // Raw/image output mode and all other modes doesn't work well with text ...
+ die();
+ }
}
// Compile characters which are allowed in URLs
-function compileUriCode ($code, $simple = true) {
+function compileUriCode ($code, $simple = TRUE) {
+ // Trim code
+ $test = trim($code);
+
+ // Is it empty?
+ if (empty($test)) {
+ // Then abort here and return the original code
+ return $code;
+ } // END - if
+
+ // Compile these by default
+ $charsCompile = array(
+ 'from' => array(
+ '{DOT}',
+ '{SLASH}',
+ '{QUOT}',
+ '{DOLLAR}',
+ '{OPEN_ANCHOR}',
+ '{CLOSE_ANCHOR}',
+ '{OPEN_SQR}',
+ '{CLOSE_SQR}',
+ '{PER}'
+ ),
+ 'to' => array(
+ '.',
+ '/',
+ chr(39),
+ '$',
+ '(',
+ ')',
+ '[',
+ ']',
+ '%'
+ )
+ );
+
// Compile constants
- if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
+ if ($simple === FALSE) {
+ // Add more 'from'
+ array_unshift($charsCompile['from'], '{--', '--}');
+
+ // Add more 'to'
+ array_unshift($charsCompile['to'], '".', '."');
+ } // END - if
// Compile QUOT and other non-HTML codes
- $code = str_replace('{DOT}', '.',
- str_replace('{SLASH}', '/',
- str_replace('{QUOT}', "'",
- str_replace('{DOLLAR}', '$',
- str_replace('{OPEN_ANCHOR}', '(',
- str_replace('{CLOSE_ANCHOR}', ')',
- str_replace('{OPEN_SQR}', '[',
- str_replace('{CLOSE_SQR}', ']',
- str_replace('{PER}', '%',
- $code
- )))))))));
+ $code = str_replace($charsCompile['from'], $charsCompile['to'], $code);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'code=' . $code);
// Return compiled code
return $code;
@@ -1234,19 +1420,43 @@ function compileUriCode ($code, $simple = true) {
// Handle message codes from URL
function handleCodeMessage () {
- if (isGetRequestParameterSet('code')) {
+ // Is 'code' set?
+ if (isGetRequestElementSet('code')) {
// Default extension is 'unknown'
$ext = 'unknown';
// Is extension given?
- if (isGetRequestParameterSet('ext')) $ext = getRequestParameter('ext');
+ if (isGetRequestElementSet('ext')) {
+ $ext = getRequestElement('ext');
+ } // END - if
// Convert the 'code' parameter from URL to a human-readable message
- $message = getMessageFromErrorCode(getRequestParameter('code'));
+ $message = getMessageFromErrorCode(getRequestElement('code'));
// Load message template
- loadTemplate('message', false, $message);
+ loadTemplate('message', FALSE, $message);
+ } // END - if
+}
+
+// Generates a 'extension foo out-dated' message
+function generateExtensionOutdatedMessage ($ext_name, $ext_ver) {
+ // Is the extension empty?
+ if (empty($ext_name)) {
+ // This should not happen
+ reportBug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
+ } // END - if
+
+ // Default message
+ $message = '{%message,EXTENSION_PROBLEM_EXTENSION_OUTDATED=' . $ext_name . '%}';
+
+ // Is an admin logged in?
+ if (isAdmin()) {
+ // Then output admin message
+ $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE'), $ext_name, $ext_name, $ext_ver);
} // END - if
+
+ // Return prepared message
+ return $message;
}
// Generates a 'extension foo inactive' message
@@ -1254,16 +1464,16 @@ function generateExtensionInactiveMessage ($ext_name) {
// Is the extension empty?
if (empty($ext_name)) {
// This should not happen
- debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
+ reportBug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
} // END - if
// Default message
- $message = getMaskedMessage('EXTENSION_PROBLEM_EXT_INACTIVE', $ext_name);
+ $message = '{%message,EXTENSION_PROBLEM_EXTENSION_INACTIVE=' . $ext_name . '%}';
// Is an admin logged in?
if (isAdmin()) {
// Then output admin message
- $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXT_INACTIVE', $ext_name);
+ $message = '{%message,ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE=' . $ext_name . '%}';
} // END - if
// Return prepared message
@@ -1275,16 +1485,16 @@ function generateExtensionNotInstalledMessage ($ext_name) {
// Is the extension empty?
if (empty($ext_name)) {
// This should not happen
- debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
+ reportBug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
} // END - if
// Default message
- $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
+ $message = '{%message,EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED=' . $ext_name . '%}';
// Is an admin logged in?
if (isAdmin()) {
// Then output admin message
- $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
+ $message = '{%message,ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED=' . $ext_name . '%}';
} // END - if
// Return prepared message
@@ -1299,17 +1509,17 @@ function generateExtensionInactiveNotInstalledMessage ($ext_name) {
// Is the extension not installed or just deactivated?
switch (isExtensionInstalled($ext_name)) {
- case true; // Deactivated!
+ case TRUE; // Deactivated!
$message = generateExtensionInactiveMessage($ext_name);
break;
- case false; // Not installed!
+ case FALSE; // Not installed!
$message = generateExtensionNotInstalledMessage($ext_name);
break;
default: // Should not happen!
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
- $message = sprintf("Invalid state of extension %s detected.", $ext_name);
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('Invalid state of extension %s detected.', $ext_name));
+ $message = sprintf('Invalid state of extension %s detected.', $ext_name);
break;
} // END - switch
@@ -1318,153 +1528,184 @@ function generateExtensionInactiveNotInstalledMessage ($ext_name) {
}
// Print code with line numbers
-function linenumberCode ($code) {
- if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
+function lineNumberCode ($code) {
+ // By default copy the code
+ $codeE = $code;
+
+ if (!is_array($code)) {
+ // We need an array, so try it with the new-line character
+ $codeE = explode(PHP_EOL, $code);
+ } // END - if
+
$count_lines = count($codeE);
$r = 'Line | Code: ';
- foreach($codeE as $line => $c) {
+ foreach ($codeE as $line => $c) {
$r .= '';
if ($count_lines == 1) {
$r .= 1;
} else {
- $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
+ $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
}
$r .= ' |';
// Add code
$r .= '' . encodeEntities($c) . '
';
- }
+ } // END - foreach
return '' . $r . '
';
}
// Determines the right page title
function determinePageTitle () {
- // Config and database connection valid?
- if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
- // Init title
- $TITLE = '';
+ // Init page title
+ $pageTitle = '';
+ // Config and database connection valid?
+ if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (isSqlLinkUp()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
// Title decoration enabled?
- if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
+ if ((isTitleDecorationEnabled()) && (getTitleLeft() != '')) {
+ $pageTitle .= '{%config,trim=title_left%} ';
+ } // END - if
- // Do we have some extra title?
+ // Is there an extra title?
if (isExtraTitleSet()) {
- // Then prepent it
- $TITLE .= getExtraTitle() . ' by ';
+ // Then prepend it
+ $pageTitle .= '{%pipe,getExtraTitle%} by ';
} // END - if
// Add main title
- $TITLE .= getMainTitle();
+ $pageTitle .= '{?MAIN_TITLE?}';
// Add title of module? (middle decoration will also be added!)
if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
- $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getModuleTitle(getModule());
+ $pageTitle .= ' {%config,trim=title_middle%} {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
} // END - if
- // Add title from what file
- $mode = '';
- if (getModule() == 'login') $mode = 'member';
- elseif (getModule() == 'index') $mode = 'guest';
- if ((!empty($mode)) && (isWhatTitleEnabled())) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
+ // Get menu mode from module
+ $menuMode = getMenuModeFromModule();
- // Add title decorations? (right)
- if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
+ // Add middle part (always in admin area!)
+ if ((!empty($menuMode)) && ((isWhatTitleEnabled()) || ($menuMode == 'admin'))) {
+ $pageTitle .= ' {%config,trim=title_middle%} ' . getTitleFromMenu($menuMode, getWhat());
+ } // END - if
- // Remember title in constant for the template
- $pageTitle = $TITLE;
+ // Add title decorations? (right)
+ if ((isTitleDecorationEnabled()) && (getTitleRight() != '')) {
+ $pageTitle .= ' {%config,trim=title_right%}';
+ } // END - if
} elseif ((isInstalled()) && (isAdminRegistered())) {
// Installed, admin registered but no ext-sql_patches
- $pageTitle = '[-- ' . getMainTitle() . ' - ' . getModuleTitle(getModule()) . ' --]';
+ $pageTitle = '[-- {?MAIN_TITLE?} - {%pipe,getModule,getModuleTitle%} --]';
} elseif ((isInstalled()) && (!isAdminRegistered())) {
// Installed but no admin registered
- $pageTitle = '{--SETUP_OF_MAILER--}';
+ $pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
} elseif ((!isInstalled()) || (!isAdminRegistered())) {
// Installation mode
- $pageTitle = '{--INSTALLATION_OF_MAILER--}';
+ $pageTitle = '{--INSTALLER_OF_MAILER--}';
} else {
- // Configuration not found!
+ // Configuration not found
$pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
// Do not add the fatal message in installation mode
- if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
+ if ((!isInstalling()) && (!isConfigurationLoaded())) {
+ // Please report this
+ reportBug(__FUNCTION__, __LINE__, 'No configuration data found!');
+ } // END - if
}
// Return title
return decodeEntities($pageTitle);
}
-// Checks wethere there is a cache file there. This function is cached.
-function isTemplateCached ($template) {
- // Do we have cached this result?
- if (!isset($GLOBALS['template_cache'][$template])) {
+// Checks whethere there is a cache file there. This function is cached.
+function isTemplateCached ($prefix, $template) {
+ // Is there cached this result?
+ if (!isset($GLOBALS['template_cache'][$prefix][$template])) {
// Generate FQFN
- $FQFN = generateCacheFqfn($template);
+ $FQFN = generateCacheFqfn($prefix, $template);
// Is it there?
- $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
+ $GLOBALS['template_cache'][$prefix][$template] = isFileReadable($FQFN);
} // END - if
// Return it
- return $GLOBALS['template_cache'][$template];
+ return $GLOBALS['template_cache'][$prefix][$template];
}
// Flushes non-flushed template cache to disk
-function flushTemplateCache ($template, $eval) {
+function flushTemplateCache ($prefix, $template, $eval) {
// Is this cache flushed?
- if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
+ if ((isDebugTemplateCacheEnabled() === FALSE) && (isTemplateCached($prefix, $template) === FALSE) && ($eval != '404')) {
// Generate FQFN
- $FQFN = generateCacheFqfn($template);
+ $FQFN = generateCacheFqfn($prefix, $template);
+
+ // Compile code another round for better performance and preserve $ signs
+ $eval = str_replace(array(chr(92), '{DOLLAR}', '{BACK}', '{CONTENT}'), array('', '$', chr(92), '$content'), compileCode(str_replace(array('$content', chr(92)), array('{CONTENT}', '{BACK}'), $eval)));
+
+ // Is this a XML template?
+ if ($prefix == 'xml') {
+ // Compact only XML templates as emails needs new-line characters and HTML may contain required "comments"
+ $eval = compactContent($eval);
+ } // END - if
// And flush it
- writeToFile($FQFN, $eval, true);
+ writeToFile($FQFN, '', TRUE);
} // END - if
}
// Reads a template cache
-function readTemplateCache ($template) {
+function readTemplateCache ($prefix, $template, $content) {
// Check it again
- if ((isDebuggingTemplateCache()) || (!isTemplateCached($template))) {
+ if ((isDebugTemplateCacheEnabled()) || (!isTemplateCached($prefix, $template))) {
// This should not happen
- debug_report_bug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
+ reportBug(__FUNCTION__, __LINE__, 'Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
} // END - if
// Is it cached?
- if (!isset($GLOBALS['template_eval'][$template])) {
+ if (!isset($GLOBALS['template_eval'][$prefix][$template])) {
// Generate FQFN
- $FQFN = generateCacheFqfn($template);
-
- // And read from it
- $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
+ $FQFN = generateCacheFqfn($prefix, $template);
+
+ /*
+ * And read from it.
+ *
+ * WARNING: Do not replace this include() call with loadInclude() as it
+ * would hide local variables away which is here required to make this
+ * work.
+ */
+ include($FQFN);
+
+ // Is the template cache valid?
+ if (!isset($templateContent)) {
+ // Please clear your cache!
+ reportBug(__FUNCTION__, __LINE__, 'Template ' . $template . ' uses old structure. Please delete all template cache files and reload.');
+ } // END - if
} // END - if
// And return it
- return $GLOBALS['template_eval'][$template];
+ return $templateContent;
}
// Escapes quotes (default is only double-quotes)
-function escapeQuotes ($str, $single = false) {
+function escapeQuotes ($str, $single = FALSE) {
// Should we escape all?
- if ($single === true) {
+ if ($single === TRUE) {
// Escape all (including null)
$str = addslashes($str);
} else {
- // Remove escaping of single quotes
- $str = str_replace("\'", "'", $str);
-
- // Escape only double-quotes but prevent double-quoting
- $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
+ // Replace all chars at once
+ $str = str_replace(array("\\'", '"', "\\\\"), array(chr(39), "\\\"", chr(92)), $str);
}
- // Return the escaped string
+ // Return the escape'd string
return $str;
}
// Escapes the JavaScript code, prevents \r and \n becoming char 10/13
function escapeJavaScriptQuotes ($str) {
// Replace all double-quotes and secure back-ticks
- $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
+ $str = str_replace(array(chr(92), '"'), array('{BACK}', '\"'), $str);
// Return it
return $str;
@@ -1473,6 +1714,9 @@ function escapeJavaScriptQuotes ($str) {
// Send out mails depending on the 'mod/modes' combination
// @TODO Lame description for this function
function sendModeMails ($mod, $modes) {
+ // Init user data
+ $content = array ();
+
// Load hash
if (fetchUserData(getMemberId())) {
// Extract salt from cookie
@@ -1482,7 +1726,7 @@ function sendModeMails ($mod, $modes) {
$hash = encodeHashForCookie(getUserData('password'));
// Does the hash match or should we change it?
- if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
+ if (($hash == getSession('u_hash')) || (postRequestElement('password1') == postRequestElement('password2'))) {
// Load the data
$content = getUserDataArray();
@@ -1497,23 +1741,23 @@ function sendModeMails ($mod, $modes) {
switch ($mode) {
case 'normal': break; // Do not add any special lines
case 'email': // Email was changed!
- $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
+ $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestElement('old_email') . PHP_EOL;
break;
- case 'pass': // Password was changed
- $content['message'] = '{--MEMBER_CHANGED_PASS--}' . "\n";
+ case 'password': // Password was changed
+ $content['message'] = '{--MEMBER_CHANGED_PASSWORD--}' . PHP_EOL;
break;
default:
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
- $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('Unknown mode %s detected.', $mode));
+ $content['message'] = '{%message,MEMBER_UNKNOWN_MODE=' . $mode . '%}' . PHP_EOL . PHP_EOL;
break;
} // END - switch
} // END - foreach
if (isExtensionActive('country')) {
// Replace code with description
- $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
+ $content['country'] = generateCountryInfo(postRequestElement('country_code'));
} // END - if
// Merge content with data from POST
@@ -1525,73 +1769,111 @@ function sendModeMails ($mod, $modes) {
if (isAdminNotificationEnabled()) {
// The admin needs to be notified about a profile change
$message_admin = 'admin_mydata_notify';
- $sub_adm = '{--ADMIN_CHANGED_DATA--}';
+ $subjectAdmin = '{--ADMIN_CHANGED_DATA_SUBJECT--}';
} else {
// No mail to admin
$message_admin = '';
- $sub_adm = '';
+ $subjectAdmin = '';
}
// Set subject lines
- $sub_mem = '{--MEMBER_CHANGED_DATA--}';
+ $subjectMember = '{--MEMBER_CHANGED_DATA--}';
// Output success message
- $content = '{--MYDATA_MAIL_SENT--} ';
+ $content['message'] = '{--MEMBER_MYDATA_MAIL_SENT--} ';
break;
default: // Unsupported module!
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
- $content = '{--UNKNOWN_MODULE--} ';
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('Unsupported module %s detected.', $mod));
+ $content['message'] = '{%message,UNKNOWN_MODULE=' . $mod . '%} ';
break;
} // END - switch
} else {
// Passwords mismatch
- $content = '{--MEMBER_PASSWORD_ERROR--} ';
+ $content['message'] = '{--MEMBER_PASSWORD_ERROR--} ';
}
} else {
// Could not load profile
- $content = '{--MEMBER_CANNOT_LOAD_PROFILE--} ';
+ $content['message'] = '{--MEMBER_CANNOT_LOAD_PROFILE--} ';
}
// Send email to user if required
- if ((!empty($sub_mem)) && (!empty($message))) {
+ if ((!empty($subjectMember)) && (!empty($message)) && (!empty($content['userid']))) {
// Send member mail
- sendEmail($content['email'], $sub_mem, $message);
+ sendEmail($content['userid'], $subjectMember, $message);
} // END - if
// Send only if no other error has occured
- if (empty($content)) {
- if ((!empty($sub_adm)) && (!empty($message_admin))) {
- // Send admin mail
- sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
- } elseif (isAdminNotificationEnabled()) {
- // Cannot send mails to admin!
- $content = '{--CANNOT_SEND_ADMIN_MAILS--}';
- } else {
- // No mail to admin
- $content = '{--MYDATA_MAIL_SENT--} ';
- }
- } // END - if
+ if ((!empty($subjectAdmin)) && (!empty($message_admin)) && (isAdminNotificationEnabled())) {
+ // Send admin mail
+ sendAdminNotification($subjectAdmin, $message_admin, $content, getMemberId());
+ } elseif (isAdminNotificationEnabled()) {
+ // Cannot send mails to admin!
+ $content['message'] = '{--CANNOT_SEND_ADMIN_MAILS--}';
+ } else {
+ // No mail to admin
+ $content['message'] = '{--MEMBER_MYDATA_MAIL_SENT--} ';
+ }
// Load template
- loadTemplate('admin_settings_saved', false, $content);
+ displayMessage($content['message']);
}
// Generates a 'selection box' from given array
-function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent = '', $extraName = '') {
+function generateSelectionBoxFromArray ($options, $name, $optionKey, $optionContent = '', $extraName = '', $templateName = '', $default = NULL, $nameElement = '', $allowNone = FALSE, $useDefaultAsArray = FALSE) {
+ // options must be an array
+ assert(is_array($options));
+
+ // Default is empty
+ $addKey = '';
+
+ // Use default value as array key?
+ if ($useDefaultAsArray === TRUE) {
+ // Then set it
+ $addKey = '[' . convertNullToZero($default) . ']';
+ } // END - if
+
// Start the output
- $OUT = '
+ $OUT = '
{--PLEASE_SELECT--} ';
+ // Allow none?
+ if ($allowNone === TRUE) {
+ // Then add it
+ $OUT .= '{--SELECT_NONE--} ';
+ } // END - if
+
// Walk through all options
foreach ($options as $option) {
- // Add the entry
+ // Default 'default' is not set
+ $option['default'] = '';
+
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'name=' . $name . ',default[' . gettype($default) . ']=' . $default . ',optionKey[' . gettype($optionKey) . ']=' . $optionKey);
+ // Is default value same as given value?
+ if ((!is_null($default)) && (isset($option[$optionKey])) && ($default === $option[$optionKey])) {
+ // Then set default
+ $option['default'] = ' selected="selected"';
+ } // END - if
+
+ // Is 'nameElement' set?
+ if ((!empty($nameElement)) && (isset($option[$nameElement]))) {
+ // Then set this as extraName, but lower-case
+ $extraName = '_' . strtolower($option[$nameElement]);
+ } // END - if
+
+ // Add the entry from ...
if (empty($optionContent)) {
- // ... from template
- $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
+ // Is a template name given?
+ if (empty($templateName)) {
+ // ... $name template
+ $OUT .= loadTemplate('select_' . $name . $extraName . '_option', TRUE, $option);
+ } else {
+ // ... $templateName template
+ $OUT .= loadTemplate('select_' . $templateName . $extraName . '_option', TRUE, $option);
+ }
} else {
- // Direct HTML code
- $OUT .= ' ' . $option[$optionContent] . ' ';
+ // ... direct HTML code
+ $OUT .= '' . $option[$optionContent] . ' ';
}
} // END - foreach
@@ -1604,22 +1886,34 @@ function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionCo
);
// Load template and return it
- return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
+ if (empty($templateName)) {
+ // Use name from $name + $extraName
+ return loadTemplate('select_' . $name . $extraName . '_box', TRUE, $content);
+ } else {
+ // Use name from $templateName + $extraName
+ return loadTemplate('select_' . $templateName . $extraName . '_box', TRUE, $content);
+ }
}
// Prepares the header for HTML output
function loadHtmlHeader () {
- // Run two filters:
- // 1.) pre_page_header (mainly loads the page_header template and includes
- // meta description)
+ /*
+ * Run two filters:
+ * 1.) pre_page_header (mainly loads the page_header template and includes
+ * meta description)
+ */
runFilterChain('pre_page_header');
- // Here can be something be added, but normally one of the two filters
- // around this line should do the job for you.
+ /*
+ * Here can be something be added, but normally one of the two filters
+ * around this line should do the job for you.
+ */
- // 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
- // to close the head-tag)
- // Include more header data here
+ /*
+ * 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
+ * to close the head-tag)
+ * Include more header data here
+ */
runFilterChain('post_page_header');
}
@@ -1629,45 +1923,46 @@ function addPageHeaderFooter () {
$OUT = '';
// Add them all together. This is maybe to simple
- foreach (array('page_header', 'output', 'page_footer') as $pagePart) {
+ foreach (array('__page_header', '__output', '__page_footer') as $pagePart) {
// Add page part if set
- if (isset($GLOBALS[$pagePart])) $OUT .= $GLOBALS[$pagePart];
+ if (isset($GLOBALS[$pagePart])) {
+ $OUT .= $GLOBALS[$pagePart];
+ } // END - if
} // END - foreach
- // Transfer $OUT to 'output'
- $GLOBALS['output'] = $OUT;
+ // Transfer $OUT to '__output'
+ $GLOBALS['__output'] = $OUT;
}
// Generates meta description for current module and 'what' value
function generateMetaDescriptionCode () {
- // Only include from guest area and if sql_patches has correct version
+ // Only include from guest area and if ext-sql_patches has correct version
if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
- // Construct dynamic description
- $DESCR = '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat());
-
// Output it directly
- $GLOBALS['page_header'] .= ' ';
+ $GLOBALS['__page_header'] .= ' ';
} // END - if
- // Remove depth
- unset($GLOBALS['ref_level']);
+ // Initialize referral system
+ initReferralSystem();
}
// Generates an FQFN for template cache from the given template name
-function generateCacheFqfn ($template, $mode = 'html') {
+function generateCacheFqfn ($prefix, $template) {
// Is this cached?
- if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
+ if (!isset($GLOBALS['template_cache_fqfn'][$prefix][$template])) {
// Generate the FQFN
- $GLOBALS['template_cache_fqfn'][$template] = sprintf(
- "%s_compiled/%s/%s.tpl.cache",
+ $GLOBALS['template_cache_fqfn'][$prefix][$template] = sprintf(
+ '%s%s_compiled/%s/%s%s',
+ getPath(),
getCachePath(),
- $mode,
- $template
+ $prefix,
+ $template,
+ getCacheExtension()
);
} // END - if
// Return it
- return $GLOBALS['template_cache_fqfn'][$template];
+ return $GLOBALS['template_cache_fqfn'][$prefix][$template];
}
// "Fixes" null or empty string to count of dashes
@@ -1685,5 +1980,565 @@ function fixNullEmptyToDashes ($str, $num) {
return $return;
}
+// Translates the "pool type" into human-readable
+function translatePoolType ($type) {
+ // Return "translation"
+ return sprintf('{--POOL_TYPE_%s--}', strtoupper($type));
+}
+
+// "Translates" given time unit
+function translateTimeUnit ($unit) {
+ // Default is unknown
+ $message = '{%message,TIME_UNIT_UNKNOWN=' . $unit . '%}';
+
+ // "Detect" it
+ if (!isset($GLOBALS['time_units'][$unit])) {
+ // Not found
+ logDebugMessage(__FUNCTION__, __LINE__, 'Unknown time unit ' . $unit . ' detected.');
+ } else {
+ // Translate it with generic function
+ $message = translateGeneric('TIME_UNIT' , $GLOBALS['time_units'][$unit]);
+ }
+
+ // Return message
+ return $message;
+}
+
+// Displays given message in admin_settings_saved template
+function displayMessage ($message) {
+ // Call inner function
+ outputHtml(returnMessage($message));
+}
+
+// Returns given message in admin_settings_saved template
+function returnMessage ($message) {
+ // Load the template
+ return loadTemplate('admin_settings_saved', TRUE, $message);
+}
+
+// Displays given error message in admin_settings_unsaved template
+function displayErrorMessage ($message) {
+ // Load the template
+ outputHtml(returnErrorMessage($message));
+}
+
+// Displays given error message in admin_settings_unsaved template
+function returnErrorMessage ($message) {
+ // Load the template
+ return loadTemplate('admin_settings_unsaved', TRUE, $message);
+}
+
+// Generates a selection box for (maybe) given gender
+function generateGenderSelectionBox ($selectedGender = '', $fieldName = 'gender') {
+ // Start the HTML code
+ $out = '';
+
+ // Add options
+ $out .= generateOptions(
+ '/ARRAY/',
+ array(
+ 'M',
+ 'F',
+ 'C'
+ ), array(
+ '{--GENDER_M--}',
+ '{--GENDER_F--}',
+ '{--GENDER_C--}'
+ ),
+ $selectedGender
+ );
+
+ // Finish HTML code
+ $out .= ' ';
+
+ // Return the code
+ return $out;
+}
+
+// Generates a selection box for given default value
+function generateTimeUnitSelectionBox ($defaultUnit, $fieldName, $unitArray) {
+ // Init variables
+ $messageIds = array();
+
+ // Generate message id array
+ foreach ($unitArray as $unit) {
+ // "Translate" it
+ array_push($messageIds, '{%pipe,translateTimeUnit=' . $unit . '%}');
+ } // END - foreach
+
+ // Start the HTML code
+ $out = '';
+
+ // Add options
+ $out .= generateOptions('/ARRAY/', $unitArray, $messageIds, $defaultUnit);
+
+ // Finish HTML code
+ $out .= ' ';
+
+ // Return the code
+ return $out;
+}
+
+// Function to add style tag (whether display:none/block)
+function addStyleMenuContent ($menuMode, $mainAction, $action) {
+ // Is there foo_menu_javascript enabled?
+ if ((!isConfigEntrySet($menuMode . '_menu_javascript')) || (getConfig($menuMode . '_menu_javascript') == 'N')) {
+ // Silently abort here, not enabled
+ return '';
+ } // END - if
+
+ // Is action=mainAction?
+ if ($action == $mainAction) {
+ // Add "menu open" style
+ return ' style="display:block"';
+ } else {
+ return ' style="display:none"';
+ }
+}
+
+// Function to add onclick attribute
+function addJavaScriptMenuContent ($menuMode, $mainAction, $action, $what) {
+ // Is there foo_menu_javascript enabled?
+ if ((!isConfigEntrySet($menuMode . '_menu_javascript')) || (getConfig($menuMode . '_menu_javascript') == 'N')) {
+ // Silently abort here, not enabled
+ return '';
+ } // END - if
+
+ // Prepare output
+ $OUT = ' onclick="return changeMenuFoldState(' . $menuMode . ', ' . $mainAction . ', ' . $action . ', ' . $what . ')';
+
+ // Return output
+ return $OUT;
+}
+
+// Tries to anonymize some sensitive data (e.g. IP address, user agent, referrer, etc.)
+function anonymizeSensitiveData ($data) {
+ // Trim it
+ $data = trim($data);
+
+ // Is it empty?
+ if (empty($data)) {
+ // Then add three dashes
+ $data = '---';
+ } elseif (isUrlValid($data)) {
+ // Is a referrer, so is it black-listed?
+ if (isAdmin()) {
+ // Is admin, has always priority
+ $data = '[{--ADMIN_TEST_URL--} ]';
+ } elseif ((isExtensionActive('blacklist')) && (isUrlBlacklisted($data))) {
+ // Yes, so replace it with text
+ $data = '{--URL_IS_BLACKLISTED--} ';
+ } else {
+ // A member is viewing this referral URL
+ $data = '[{--MEMBER_TEST_URL--} ]';
+ }
+ } elseif (isIp4AddressValid($data)) {
+ // Is an IPv4 address
+ $ipArray = explode('.', $data);
+
+ // Only display first 2 octets
+ $data = $ipArray[0] . '.' . $ipArray[1] . '.?.?';
+ } else {
+ // Generic data
+ $data = '{--DATA_IS_HIDDEN--} ';
+ }
+
+ // Return it (hopefully) anonymized
+ return $data;
+}
+
+/**
+ * Removes all comments, tabs and new-line characters to compact the content
+ *
+ * @param $uncompactedContent The uncompacted content
+ * @return $compactedContent The compacted content
+ */
+function compactContent ($uncompactedContent) {
+ // First, remove all tab/new-line/revert characters
+ $compactedContent = str_replace(chr(9), '', str_replace(PHP_EOL, '', str_replace(chr(13), '', $uncompactedContent)));
+
+ // Make a space after >
+ $compactedContent = str_replace(array('>', ' '), array('> ', ' '), $compactedContent);
+
+ // Then regex all comments like away
+ preg_match_all('//', $compactedContent, $matches);
+
+ // Do we have entries?
+ if (isset($matches[0][0])) {
+ // Remove all
+ foreach ($matches[0] as $match) {
+ // Remove the match
+ $compactedContent = str_replace($match, '', $compactedContent);
+ } // END - foreach
+ } // END - if
+
+ // Return compacted content
+ return $compactedContent;
+}
+
+//-----------------------------------------------------------------------------
+// Template helper functions for EL code
+//-----------------------------------------------------------------------------
+
+// Color-switch helper function
+function doTemplateColorSwitch ($templateName, $clear = FALSE, $return = TRUE) {
+ // Is it there?
+ if (!isset($GLOBALS['color_switch'][$templateName])) {
+ // Initialize it
+ initTemplateColorSwitch($templateName);
+ } elseif ($clear === FALSE) {
+ // Switch color if called from loadTemplate()
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SWITCH:' . $templateName);
+ $GLOBALS['color_switch'][$templateName] = 3 - $GLOBALS['color_switch'][$templateName];
+ }
+
+ // Return CSS class name
+ if ($return === TRUE) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'RETURN:' . $templateName . '=' . $GLOBALS['color_switch'][$templateName]);
+ return 'switch_sw' . $GLOBALS['color_switch'][$templateName];
+ } // END - if
+}
+
+// Helper function for extension registration link
+function doTemplateExtensionRegistrationLink ($templateName, $clear, $ext_name) {
+ // Default is all non-productive
+ $OUT = '{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}
';
+
+ // Is the given extension non-productive?
+ if (isExtensionDeprecated($ext_name)) {
+ // Is deprecated
+ $OUT = '--- ';
+ } elseif (isExtensionProductive($ext_name)) {
+ // Productive code
+ $OUT = '{--ADMIN_TASK_REGISTER_EXTENSION--} ';
+ }
+
+ // Return code
+ return $OUT;
+}
+
+// Helper function to create bonus mail admin links
+function doTemplateAdminBonusMailLinks ($templateName, $clear, $bonusId) {
+ // Call the inner function
+ return generateAdminMailLinks('bonus', $bonusId);
+}
+
+// Helper function to create member mail admin links
+function doTemplateAdminMemberMailLinks ($templateName, $clear, $mailId) {
+ // Call the inner function
+ return generateAdminMailLinks('normal', $mailId);
+}
+
+// Helper function to create a selection box for YES/NO configuration entries
+function doTemplateConfigurationYesNoSelectionBox ($templateName, $clear, $configEntry) {
+ // Default is a "missing entry" warning
+ $OUT = '!' . $configEntry . '!
';
+
+ // Generate the HTML code
+ if (isConfigEntrySet($configEntry)) {
+ // Configuration entry is found
+ $OUT = '
+{%config,generateYesNoOptions=' . $configEntry . '%}
+ ';
+ } // END - if
+
+ // Return it
+ return $OUT;
+}
+
+// Helper function to create a selection box for YES/NO form fields
+function doTemplateYesNoSelectionBox ($templateName, $clear, $formField) {
+ // Generate the HTML code
+ $OUT = '
+{%pipe,generateYesNoOptions%}
+ ';
+
+ // Return it
+ return $OUT;
+}
+
+// Helper function to create a selection box for YES/NO form fields, by NO is default
+function doTemplateNoYesSelectionBox ($templateName, $clear, $formField) {
+ // Generate the HTML code
+ $OUT = '
+{%pipe,generateYesNoOptions=N%}
+ ';
+
+ // Return it
+ return $OUT;
+}
+
+// Helper function to add extra content for guest area (module=index and others)
+function doTemplateGuestFooterExtras ($templateName, $clear) {
+ // Init filter data
+ $filterData = array(
+ // Name of used template
+ 'template' => $templateName,
+ // Target array for gathered data
+ '__data' => array(),
+ // Where the HTML output will go
+ '__output' => '',
+ );
+
+ // Run the filter chain
+ $filterData = runFilterChain('guest_footer_extras', $filterData);
+
+ // Return output
+ return $filterData['__output'];
+}
+
+// Helper function to add extra content for member area (module=login)
+function doTemplateMemberFooterExtras ($templateName, $clear) {
+ // Is a member logged in?
+ if (!isMember()) {
+ // This shall not happen
+ reportBug(__FUNCTION__, __LINE__, 'Please use this template helper only for logged-in members.');
+ } // END - if
+
+ // Init filter data
+ $filterData = array(
+ // Current user's id number
+ 'userid' => getMemberId(),
+ // Name of used template
+ 'template' => $templateName,
+ // Target array for gathered data
+ '__data' => array(),
+ // Where the HTML output will go
+ '__output' => '',
+ );
+
+ // Run the filter chain
+ $filterData = runFilterChain('member_footer_extras', $filterData);
+
+ // Return output
+ return $filterData['__output'];
+}
+
+/**
+ * Helper function to determine whether current userid is set, if none is set,
+ * return a zero, else an EL code is being returned as of this function is used
+ * only in templates.
+ *
+ * @param $templateName Name of template (unused)
+ * @param $clear Wether to clear something (unused)
+ * @return $userId Wether zero or EL code snippet
+ */
+function doTemplateUserId ($templateName, $clear) {
+ // By default no userid is set
+ $userId = '0';
+
+ // Is there a user id currently set?
+ if (isCurrentUserIdSet()) {
+ // Then get the current user id
+ $userId = getCurrentUserId();
+ } // END - if
+
+ // Return it
+ return $userId;
+}
+
+// Template helper function to generate "Terms&Conditions" link (EL code again)
+function doTemplateGetTermsConditionsLink ($templateName, $clear) {
+ /*
+ * Use default link by default ;-) This link, however, will become
+ * deprecated once ext-terms is rolled out.
+ */
+ $linkCode = '{%url=modules.php?module=index&what=agb%}';
+
+ // Is ext-terms installed?
+ if (isExtensionInstalled('terms')) {
+ // Then use that link (only 'what' has changed)
+ $linkCode = '{%url=modules.php?module=index&what=terms%}';
+ } // END - if
+
+ // Return link (EL) code
+ return $linkCode;
+}
+
+// Template helper function to create selection box for "locked points mode"
+function doTemplatePointsLockedModeSelectionBox ($templateName, $clear = FALSE, $default = NULL) {
+ // Init array
+ $lockedModes = array(
+ 0 => array('mode' => 'LOCKED'),
+ 1 => array('mode' => 'UNLOCKED'),
+ );
+
+ // Handle it over to generateSelectionBoxFromArray()
+ $content = generateSelectionBoxFromArray($lockedModes, 'points_locked_mode', 'mode', '', '', '', $default);
+
+ // Return prepared content
+ return $content;
+}
+
+// Template helper function to create selection box for payment method
+function doTemplatePointsPaymentMethodSelectionBox ($templateName, $clear = FALSE, $default = NULL) {
+ // Init array
+ $paymentMethods = array(
+ 0 => array('method' => 'DIRECT'),
+ 1 => array('method' => 'REFERRAL'),
+ );
+
+ // Handle it over to generateSelectionBoxFromArray()
+ $content = generateSelectionBoxFromArray($paymentMethods, 'points_payment_method', 'method', '', '', '', $default);
+
+ // Return prepared content
+ return $content;
+}
+
+// Template helper function to create a deferrer code if URL is not empty
+function doTemplateDereferrerUrl ($templateName, $clear = FALSE, $url = NULL) {
+ // Is the URL not NULL and not empty?
+ if ((!is_null($url)) && (!empty($url))) {
+ // Set HTML with EL code
+ $url = '{--ADMIN_TEST_URL--} ';
+ } // END - if
+
+ // Return URL (or content) or dashes if empty
+ return fixEmptyContentToDashes($url);
+}
+
+// Load another template and return its content
+function doTemplateLoadTemplate ($templateName, $clear = FALSE, $theTemplate, $content = array()) {
+ // Load "the" template
+ return loadTemplate($theTemplate, TRUE, $content);
+}
+
+// Output HTML code for favicon.ico, if found
+function doTemplateMetaFavIcon ($templateName, $clear = FALSE) {
+ // Default is not found
+ $out = '';
+
+ // Check all common extensions
+ foreach (array('ico', 'gif', 'png') as $extension) {
+ // Is the file there?
+ if (isFileReadable(getPath() . 'favicon.' . $extension)) {
+ // Then use this and abort
+ $out = ' ';
+ break;
+ } // END - if
+ } // END - while
+
+ // Return code
+ return $out;
+}
+
+// Helper function to display referral id or hide it depending on settings
+function doTemplateDisplayReferralIdContent ($template, $clear = FALSE) {
+ // Ddisplay the refid or make it editable?
+ if (isDisplayRefidEnabled()) {
+ // Load "hide" form template
+ $out = loadTemplate('guest_register_refid_hide', TRUE);
+ } else {
+ // Load template to enter it
+ $out = loadTemplate('guest_register_refid', TRUE);
+ }
+
+ // Return code
+ return $out;
+}
+
+// "Getter" for template base path
+function getTemplateBasePath ($part) {
+ // Is there cache?
+ if (!isset($GLOBALS[__FUNCTION__][$part])) {
+ // "Build" path
+ $GLOBALS[__FUNCTION__][$part] = sprintf('%stemplates/%s/%s', getPath(), getLanguage(), $part);
+ } // END - if
+
+ // Return cache
+ return $GLOBALS[__FUNCTION__][$part];
+}
+
+// Removes comments with @DEPRECATED
+function removeDeprecatedComment ($output) {
+ // Explode it into pieces ... ;)
+ $lines = explode(chr(10), $output);
+
+ // Walk through all
+ $return = '';
+ foreach ($lines as $line) {
+ // Is there a @DEPRECATED?
+ if (isInString('@DEPRECATED', $line)) {
+ // Ignore this line
+ continue;
+ } // END - if
+
+ // Add it
+ $return .= $line . chr(13);
+ } // END - foreach
+
+ // Returned cleaned content
+ return $return;
+}
+
+// Generates a selection box suitable for e.g. birthdays: day, month and year
+function generateDayMonthYearSelectionBox ($day, $month, $year) {
+ // This depends on selected language
+ switch (getLanguage()) {
+ case 'de': // German date format
+ $content = addSelectionBox('da', $day) . addSelectionBox('mo', $month) . addSelectionBox('ye', $year);
+ break;
+
+ default: // Default is the US date format... :)
+ $content = addSelectionBox('mo', $month) . addSelectionBox('da', $day) . addSelectionBox('ye', $year);
+ break;
+ } // END - switch
+
+ // Return content
+ return $content;
+}
+
+// Loads page header
+function loadPageHeader () {
+ // Init header
+ $GLOBALS['__page_header'] = '';
+
+ // Is the header already sent?
+ if (($GLOBALS['__header_sent'] != 1) && ($GLOBALS['__header_sent'] != 2)) {
+ // Set default HTTP status to "200 OK"
+ setHttpStatus('200 OK');
+
+ // If not in CSS mode generate the header
+ if ((!isCssOutputMode()) && (!isAjaxOutputMode()) && (!isImageOutputMode())) {
+ // Prepare the header for HTML output
+ loadHtmlHeader();
+ } // END - if
+
+ // Closing HEAD tag
+ if ($GLOBALS['__header_sent'] == '0') {
+ $GLOBALS['__header_sent'] = 1;
+ } // END - if
+ } // END - if
+
+ // Add BODY tag or not?
+ // @TODO Find a way to not use direct module comparison
+ if ((!isCssOutputMode()) && (!isRawOutputMode()) && ($GLOBALS['__header_sent'] == 1) && (getModule() != 'frametester') && (!isFramesetModeEnabled())) {
+ loadTemplate('page_body');
+ $GLOBALS['__header_sent'] = 2;
+ } // END - if
+}
+
+// Loads page footer and calls doShutdown()
+function loadPageFooter () {
+ // Init page footer
+ $GLOBALS['__page_footer'] = '';
+
+ // Footer disabled (e.g. CSS/AJAX/image output) or already sent?
+ // 1234 5 54 45 5 5 543 3 443 3 443 3 44321
+ if ((((!isset($GLOBALS['__footer_sent'])) || (($GLOBALS['__footer_sent'] != 1) && ($GLOBALS['__footer_sent'] != 2))) && (!isCssOutputMode()) && (!isAjaxOutputMode()) && (!isImageOutputMode()))) {
+ // Run the filter, sweet huh?
+ runFilterChain('page_footer');
+
+ // Load page footer
+ $GLOBALS['__page_footer'] .= loadTemplate('page_footer', TRUE);
+ } // END - if
+
+ // Footer has been reached
+ $GLOBALS['__footer_sent'] = 1;
+
+ // Shutdown
+ doShutdown();
+}
+
// [EOF]
?>